---
title: "REST API: Check Space Name Availability"
type: "wiki"
space: "Axero Documentation"
author: "Anonymous User"
created: 2011-03-29T07:50:12Z
updated: 2026-09-28T01:08:35Z
tags: ["API"]
url: "https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/518/rest-api-check-space-name-availability"
---

# REST API: Check Space Name Availability

[Open API Guide](https://my.axerosolutions.com/spaces/5/axero-documentation/api-guide?id=518)
GET/api/spaces/availability

Check whether a space name can be used. ResponseData is the string True when the name is free and False when it is taken, which is the opposite of the file directory name check.

## Request

### Request Header
| Header | Required | Value | Description |
| :--- | :--- | :--- | :--- |
| `Authorization` | YES | `Bearer YOUR_TOKEN` | Bearer token for the authenticated user. [Learn how to create Bearer tokens](https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/108973/creating-bearer-tokens) |
### Required Parameters
| Parameter | Type | Required | Location | Description |
| :--- | :--- | :--- | :--- | :--- |
| `SpaceName` | String | YES | Query | Name to check. It must match an existing space name exactly to count as taken, but letter case is ignored. |
## Example

### Request Header

```
Authorization: Bearer YOUR_TOKEN
```

### Request URL

`https://your-site.com/api/spaces/availability?spacename=Customers`

### Success Response

```
{
  "IsError": false,
  "ResponseMessage": "Customers",
  "ResponseData": "True"
}
```

### Error Response

```
{
  "Message": "The request is invalid."
}
```

## Error Handling

| Status Code | Likely Cause | Next Action |
| :--- | :--- | :--- |
| 400 Bad Request | SpaceName was left out of the query string. | Verify the request payload against the required parameters |
| 401 Unauthorized | Missing or invalid Bearer token | Check token validity. [Learn how to create Bearer tokens →](https://my.axerosolutions.com/spaces/5/axero-documentation/wiki/view/108973/creating-bearer-tokens) |
| 403 Forbidden | Not returned: the endpoint makes no permission check. | No action needed. |
| 500 Server Error | SpaceName is empty or only spaces; the response body is empty. Otherwise, an internal failure. | Send a SpaceName with at least one character that is not a space. For any other 500, retry later. |

## Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

- **Sustained Request Rate:** Do not exceed 5 API calls per second
- **Sequential Processing:** Wait for each request to complete before sending the next in automated workflows
- **Concurrent Connections:** If parallel processing is required, limit to 3 or fewer simultaneous requests
- **Response Timeout:** Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.