Retrieve project by slug

get

https://api-reelly.up.railway.app/api/v2/clients/projects/slug/{slug_name}

Returns the same full, detailed project payload as GET /api/v2/clients/projects/{id}, but looked up by the project's URL-friendly slug_name instead of its numeric id. Use this endpoint when you only have the slug — for example, when resolving SEO-friendly URLs, deep links shared externally, or cross-system references that carry the slug rather than the internal id. The response schema is identical to the id-based retrieve endpoint (RetrieveProject). Returns 404 if no project with the given slug_name exists or the project is not accessible to the client.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

slug_name

string

required

URL-friendly slug identifying the project (lowercase ASCII letters, digits, and dashes). Assigned the first time the project is published and stable thereafter — safe to embed in shareable URLs. See the slug_name field on ListProject and RetrieveProject responses.

Query Params

format

string

enum

Allowed:

language

string

Defaults to en-us

Specifies the language used for localized text fields in the project details response. Supported language codes correspond to the values returned by the metadata endpoint. GET /api/v2/clients/projects/languages.

preferred_area_unit

string

enum

Defaults to sqft

Controls the unit used for area-related fields in the project details response. The parameter influences: min_size, max_size, area_unit fields in the response.

Allowed:

preferred_currency

string

enum

Defaults to AED

Controls the currency used for aggregated price fields in the project details response. The parameter affects: min_price, max_price, price_currency fields in the response.

Allowed:

Headers

X-API-Key

string

required

Custom token for client authentication.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication credentials were not provided or are invalid.

403

You do not have permission to perform this action.

404

Not found.

200