Skip to main content

Query for contacts

GET 
/api/v3/user

Available query parameter values for filtering:

  • user_id
  • external_key
  • first_name
  • last_name
  • email
  • phone
  • user_type_id
  • username
  • customers.customer_id - Get contacts belonging to a specific customer

Request​

Query Parameters

    where string

    first_name:EQUALS:jane

    order string

    user_id:ASC

    limit string

    2

    offset string

    8

Responses​

Object was fetched successfully

Schema

    code integer
    status string
    message stringnullable
    details objectnullable

    response

    object[]

  • Array [

    • user_id integer

    The user/contact ID #

    external_key string

    External key value

    token string

    Unique token

    username string

    Customer portal username

    name string

    First and last name of the contact

    first_name string

    First name of contact

    middle_name_glob string

    Middle name/initial

    last_name string

    Last name

    name_suffix string

    Suffix (e.g. "Jr.", "Sr.", "III", etc.)

    display_as string

    (deprecated)

    title string

    Title

    email string

    E-mail address

    phone string

    Phone number

    mobile string

    Mobile number

    user_type_id integer

    User type ID #

    user_type_name string

    User type

    customer_id integer

    The customer ID # this contact belongs to

    custom_1 string

    Custom field #1

    custom_2 string

    Custom field #2

    custom_3 string

    Custom field #3

    custom_4 string

    Custom field #4

    custom_5 string

    Custom field #5

    custom_6 string

    Custom field #6

    custom_7 string

    Custom field #7

    custom_8 string

    Custom field #8

    custom_9 string

    Custom field #9

    custom_10 string

    Custom field #10

    custom_11 string

    Custom field #11

    custom_12 string

    Custom field #12

    custom_13 string

    Custom field #13

    custom_14 string

    Custom field #14

    custom_15 string

    Custom field #15

    custom_16 string

    Custom field #16

    custom_17 string

    Custom field #17

    custom_18 string

    Custom field #18

    custom_19 string

    Custom field #19

    custom_20 string

    Custom field #20

    write_datetime string

    Date/time the user/contact was created

    mod_datetime string

    Date/time the user/contact was last modified

    url_self string

    URL for viewing the user/contact in the GUI

  • ]

Loading...