Address Book

Get a list of all contacts in an organization.

get/api/v1/addressbook/contacts

Request

  • Base URL: https://api.fordefi.com
  • URL: https://api.fordefi.com/api/v1/addressbook/contacts
  • Auth: HTTP bearer

Query parameters

sort_byContactSortableFields[]
pageinteger

The page number to fetch.

sizeinteger

The number of items per page.

skip_countboolean

Whether to skip counting the total number of items.

contact_idsstring[]

The contact IDs to filter by.

namesstring[]

The names to filter by.

statesAddressBookContactState[]

The states to filter by.

chain_typesChainType[]

The chain types to filter by.

chainsstring[]

The chain unique ids to filter by.

asset_idsstring[]

List of asset identifiers to filter on.

address_group_idsstring[]

The address group IDs to filter by.

exclude_address_group_idsstring[]

List of address group IDs to exclude.

exclude_contact_idsstring[]

List of contact IDs to exclude.

contact_typesContactType[]

The contact types to filter by. unset selects contacts created before contact types existed, which are the ones an edit must assign a type to.

Response

Successful Response

totalinteger required
pageinteger required
sizeinteger required

Changes

    • info

      added the new optional query request parameter contact_types

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • breaking

      the /////////// response property's maxLength was increased from 251 to 255 for the response status

    • breaking

      the /////////// response property's maxLength was increased from 251 to 255 for the response status

    • breaking

      the /////////// response property's maxLength was increased from 251 to 255 for the response status

    • breaking

      the /////////// response property's maxLength was increased from 251 to 255 for the response status

    • breaking

      the /////////// response property's maxLength was increased from 251 to 255 for the response status

    • breaking

      the /////////// response property's maxLength was increased from 251 to 255 for the response status

    • breaking

      the /////////// response property's maxLength was increased from 251 to 255 for the response status

    • breaking

      the /////////// response property's maxLength was increased from 251 to 255 for the response status

    • breaking

      the /////////// response property's maxLength was increased from 251 to 255 for the response status

    • breaking

      the /////////// response property's maxLength was increased from 251 to 255 for the response status

    • breaking

      the /////////// response property's maxLength was increased from 251 to 255 for the response status

    • breaking

      the /////////// response property's maxLength was increased from 251 to 255 for the response status

    • breaking

      the /////////// response property's maxLength was increased from 251 to 255 for the response status

    • breaking

      the /////////// response property's maxLength was increased from 251 to 255 for the response status

    • warning

      added the new pending_import enum value to the /// response property for the response status

    • warning

      added the new pending_import enum value to the /// response property for the response status

    • warning

      added the new pending_import enum value to the /// response property for the response status

    • warning

      added the new pending_import enum value to the /// response property for the response status

    • warning

      added the new pending_import enum value to the /// response property for the response status

    • warning

      added the new pending_import enum value to the /// response property for the response status

    • warning

      added the new pending_import enum value to the /// response property for the response status

    • warning

      added the new pending_import enum value to the /// response property for the response status

    • warning

      added the new pending_import enum value to the /// response property for the response status

    • warning

      added the new pending_import enum value to the /// response property for the response status

    • warning

      added the new pending_import enum value to the /// response property for the response status

    • warning

      added the new pending_import enum value to the /// response property for the response status

    • warning

      added the new pending_import enum value to the /// response property for the response status

    • warning

      added the new pending_import enum value to the /// response property for the response status

    • info

      added the enum value pending_import to the property items/ of the query request parameter states

    • info

      the ////////// response's property pattern ^0[xX][a-fA-F0-9]+$ was added for the status

    • info

      the /////////// response's property pattern ^[a-zA-Z0-9_-]+::12[a-fA-F0-9]{66}$ was added for the status

    • info

      the ////////// response's property pattern ^0[xX][a-fA-F0-9]+$ was added for the status

    • info

      the /////////// response's property pattern ^[a-zA-Z0-9_-]+::12[a-fA-F0-9]{66}$ was added for the status

    • info

      the ////////// response's property pattern ^0[xX][a-fA-F0-9]+$ was added for the status

    • info

      the /////////// response's property pattern ^[a-zA-Z0-9_-]+::12[a-fA-F0-9]{66}$ was added for the status

    • info

      the ////////// response's property pattern ^0[xX][a-fA-F0-9]+$ was added for the status

    • info

      the /////////// response's property pattern ^[a-zA-Z0-9_-]+::12[a-fA-F0-9]{66}$ was added for the status

    • info

      the ////////// response's property pattern ^0[xX][a-fA-F0-9]+$ was added for the status

    • info

      the /////////// response's property pattern ^[a-zA-Z0-9_-]+::12[a-fA-F0-9]{66}$ was added for the status

    • info

      the ////////// response's property pattern ^0[xX][a-fA-F0-9]+$ was added for the status

    • info

      the /////////// response's property pattern ^[a-zA-Z0-9_-]+::12[a-fA-F0-9]{66}$ was added for the status

    • info

      the ////////// response's property pattern ^0[xX][a-fA-F0-9]+$ was added for the status

    • info

      the /////////// response's property pattern ^[a-zA-Z0-9_-]+::12[a-fA-F0-9]{66}$ was added for the status

    • info

      the ////////// response's property pattern ^0[xX][a-fA-F0-9]+$ was added for the status

    • info

      the /////////// response's property pattern ^[a-zA-Z0-9_-]+::12[a-fA-F0-9]{66}$ was added for the status

    • info

      the ////////// response's property pattern ^0[xX][a-fA-F0-9]+$ was added for the status

    • info

      the /////////// response's property pattern ^[a-zA-Z0-9_-]+::12[a-fA-F0-9]{66}$ was added for the status

    • info

      the ////////// response's property pattern ^0[xX][a-fA-F0-9]+$ was added for the status

    • info

      the /////////// response's property pattern ^[a-zA-Z0-9_-]+::12[a-fA-F0-9]{66}$ was added for the status

    • info

      the ////////// response's property pattern ^0[xX][a-fA-F0-9]+$ was added for the status

    • info

      the /////////// response's property pattern ^[a-zA-Z0-9_-]+::12[a-fA-F0-9]{66}$ was added for the status

    • info

      the ////////// response's property pattern ^0[xX][a-fA-F0-9]+$ was added for the status

    • info

      the /////////// response's property pattern ^[a-zA-Z0-9_-]+::12[a-fA-F0-9]{66}$ was added for the status

    • info

      the ////////// response's property pattern ^0[xX][a-fA-F0-9]+$ was added for the status

    • info

      the /////////// response's property pattern ^[a-zA-Z0-9_-]+::12[a-fA-F0-9]{66}$ was added for the status

    • info

      the ////////// response's property pattern ^0[xX][a-fA-F0-9]+$ was added for the status

    • info

      the /////////// response's property pattern ^[a-zA-Z0-9_-]+::12[a-fA-F0-9]{66}$ was added for the status