Skip to main content
GET

Authorizations

Authorization
string
header
required

API key passed as a Bearer token in the Authorization header.

Headers

x-api-version
enum<string>
default:2025-11-01
required

API version to use. This endpoint currently requires 2025-11-01. Requests without the header, or with any other value, return 400.

Available options:
2025-11-01
Example:

"2025-11-01"

Query Parameters

path
string

Return only the endpoint at this exact path, for example /company/enrich. The match is exact and case-sensitive: the leading slash is required, a trailing slash does not match, and a prefix such as /company matches nothing. Any path that does not match returns an empty endpoints array rather than 404.

Example:

"/company/enrich"

category
string

Return only endpoints in this product category. Matching is case-insensitive, so Company, company, and COMPANY all return the same 8 entries. On the 2025-11-01 version the categories are Company, Person, Jobs, Web, Social, and Other. An unknown category returns an empty endpoints array.

Example:

"Company"

status
enum<string>

Return only endpoints with this access status. The value is case-sensitive and must be lowercase. Any other value, including Enabled, returns 400.

Available options:
enabled,
disabled
Example:

"enabled"

Response

Endpoint permission overview for the account, narrowed by whichever filters you passed.

Each example below names the query string that produced it. The examples whose summary says truncated have had entries or field lists shortened so the shape stays readable; the rest are complete responses exactly as returned. Entry counts and field counts quoted in the summaries are the real ones.

Endpoint permission overview for the account. Holds one entry per product endpoint unless a path, category, or status filter narrowed it.

api_version
string
required

API version the field permissions were resolved against. Echoes the x-api-version request header.

Example:

"2025-11-01"

token_limit_rpm
integer | null
required

Account-level rate limit in requests per minute across all endpoints. null when no account-level limit is configured, which is the usual case and what the examples on this endpoint show. The per-endpoint limit in effective_rate_limit_rpm is what applies to a given call.

Example:

200

endpoints
object[]
required

One entry per Crustdata API endpoint, sorted by path and narrowed by any path, category, or status filters. Empty when the filters match nothing.

Example: