Lookup Address's Single Card

Options

Entity Id

UUID or permalink of desired entity

Card Id

A card to include on the resulting entity

Card Field Ids (*)

Card fields to include on the specified card - array of field_id strings in JSON encoded as string

After Id (*)

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 (*)

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 (*)

Field name with order direction (asc/desc)

Limit (*)

Number of rows to return. Default is 100, min is 1, max is 100.

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Structured Table: Returns a parsed table with data split into rows and columns.

• Country Code: Country Code
  Field Type: text_exact
  Searchable: Yes
  Search Operators: blank, eq, includes, not_eq, not_includes
• Created At: Field Type: datetime
  Searchable: Yes
  Search Operators: between, blank, eq, gte, lte
• Entity Def Id:

  Field Type: enum
  Searchable: Yes
  Search Operators: blank, eq, includes, not_eq, not_includes
  Possible values are:

  • address - Address
• Headquartered Organization Identifier: Identifier of the organization that's headquartered on this address
  Field Type: identifier
  Searchable: Yes
  Search Operators: blank, contains, eq, includes, not_contains, not_eq, not_includes, starts
• Identifier: Descriptive name of the Address (e.g. Headquarters, London Office)
  Field Type: identifier
  Searchable: Yes
  Search Operators: blank, contains, eq, includes, not_contains, not_eq, not_includes, starts
• Location Identifiers: What city the address is located in (e.g. San Francisco, London, Kiev).
  Field Type: identifier_multi
  Searchable: Yes
  Search Operators: blank, includes, includes_all, not_includes, not_includes_all
• Name: Descriptive name of the Address (e.g. Headquarters, London Office)
  Field Type: text_blob
  Searchable: No
• Postal Code: The postal code of the address
  Field Type: text_blob
  Searchable: No
• Region Code: Region Code
  Field Type: text_exact
  Searchable: Yes
  Search Operators: blank, eq, includes, not_eq, not_includes
• Street 1: The street address of the location
  Field Type: text_blob
  Searchable: No
• Street 2: The street address of the location
  Field Type: text_blob
  Searchable: No
• Updated At: Field Type: datetime
  Searchable: Yes
  Search Operators: between, blank, eq, gte, lte
• Uuid: Field Type: uuid
  Searchable: Yes
  Search Operators: blank, eq, includes, not_eq, not_includes

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers