Space is the designated name for your group or folder, allowing you to organize URLs efficiently. If you’re curious to learn more about creating a space, refer to this article.
Create a Space #
POST /api/user/v1/space
curl --location --request POST 'https://apiv2.foxlyme.com/api/user/v1/space' \
--header 'api-key: API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"space_name": "YOUR_SPACE_NAME"
}'Request Schema:
space_name(string)
Response Body:
{
"error": false,
"message": "string",
"data": {
"space_name": "string",
"space_id": "string",
"user_id": "string",
"created_at": "date"
}
}
Update a Space #
Update specific fields in a space.
PUT /api/user/v1/space/update
curl --location --request PUT 'https://apiv2.foxlyme.com/api/user/v1/space/update?space_id=string' \
--header 'api-key: API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"space_name": "YOUR_SPACE_NAME"
}'Request Schema:
space_name(string)space_id(query, string)
Response Body:
{
"error": false,
"message": "space updated successfully",
"data": {
"space_name": "YOUR_SPACE_NAME",
"space_id": "string",
"user_id": "string",
"updated_at": "date"
}
}
Get Space Details #
Retrieve specific space information.
GET /api/user/v1/space/detail
curl --location --request GET 'https://apiv2.foxlyme.com/api/user/v1/space/detail?space_id=string' \
--header 'api-key: API_KEY'Request Schema:
space_id(query, string)
Response Body:
{
"error": false,
"message": "space detail fetched successfully",
"data": {
"space_name": "YOUR_SPACE_NAME",
"space_id": "string",
"user_id": "string",
"created_at": "date"
}
}
List Space URLs #
Retrieve all URLs for a specific space.
GET /api/user/v1/space/urls
curl --location --request GET 'https://apiv2.foxlyme.com/api/user/v1/space/urls?
space_id=string&page=1&limit=5' \
--header 'api-key: API_KEY'Request Schema:
space_id(query, string)
Response Body:
{
"message": "space's all urls successfully",
"count": "number",
"data": [
{
"long_url": "string",
"space_id": "string",
"short_code": "string",
"url_shortner_id": "string",
"space_name": "string",
"status": "number",
"created_at": "date"
}
]
}Response Values:
status(number)user_id(string)long_url(string)short_code(string)short_url(string)space_id(string)url_shortner_id(string)space_name(string)
Delete a Space #
Remove a specific space.
DELETE /api/user/v1/space/delete
curl --location --request DELETE 'https://apiv2.foxlyme.com/api/user/v1/space/delete?space_id=string' \
--header 'api-key: API_KEY'Request Schema:
space_id(query, string)
Get All Spaces #
Description: #
Retrieve detailed information about all your spaces using this API.
API Endpoint: #
GET /api/user/v1/space/all
Request Example: #
curl --location --request GET 'https://apiv2.foxlyme.com/api/user/v1/space/all' \
--header 'api-key: YOUR_API_KEY'Request Body: #
No request body is needed for this endpoint.
Response Body: #
{
"message": "All spaces' information retrieved successfully",
"data": [
{
"_id": Number,
"space_name": "string",
"space_id": "string",
"created_at": "string",
"updated_at": "string"
}
]
}
In the response, you will receive a message confirming the successful retrieval of the information along with an array of data objects, each containing the following fields:
_id: A unique identifier for the space.space_name: The name of the space.space_id: The unique ID of the space.created_at: The creation timestamp of the space.updated_at: The last update timestamp of the space.
