Lookup Address's single card

get

https://api.crunchbase.com/v4/data/entities/addresses/{entity_id}/cards/{card_id}

The following cards are available: [event, organization]

Path Params

entity_id

string

required

UUID or permalink of desired entity

card_id

string

enum

required

An address card to lookup

Allowed:

Query Params

card_field_ids

array of strings

Comma-separated field IDs to include on the specified card, for example identifier,uuid. JSON-encoded arrays are not accepted.

card_field_ids

after_id

uuid

Lookup uuid of the last item in the previous page (not required for first page). Used to iterate a card's results starting at the beginning of the ordered set and moving forward. Suitable for implementing "next page" functionality. May not be provided simultaneously with before_id.

before_id

uuid

Lookup uuid of the first item in the previous page (not required for first page). Used to iterate a card's results starting at the end of the ordered set and moving backward. Suitable for implementing "previous page" functionality. May not be provided simultaneously with after_id.

order

string

Field name with order direction (asc/desc)

limit

integer

0 to 100

Defaults to 100

Number of rows to return. Default is 100, minimum is 0, maximum is 100. A limit of 0 returns no card items.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200The entity and the requested card contents. Card fields and relationships may be absent when unavailable.

400Bad Request

401Missing or invalid API credentials. Supply your API key in the X-cb-user-key header. Gateway errors can be returned as text/plain containing a JSON error array.

404Not Found

429Too many requests. This can result from rate limits, concurrent requests or platform load. Reduce concurrency and retry with exponential backoff and jitter; see https://data.crunchbase.com/docs/using-the-api. The response body and headers are not guaranteed by this reference.

500Request Failed