Contents x
    Get a list of customers
    • 22 Nov 2024
    • 3 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Get a list of customers

    • Updated on 22 Nov 2024
    • 3 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Article summary

    Get
    /customer/v1/customers

    Get a list of customers either with or without search parameters

    Security
    HTTP
    Type bearer
    Query parameters
    filter[email]
    string
    Min length1
    filter[name]
    string
    Min length1
    page[size]
    number
    Minimum1
    page[cursor]
    string
    Min length1
    Responses
    200

    The list of customers that match the search criteria

    Expand All
    object
    data
    Array of object

    The list of customers.

    object
    type
    string

    The type of the object

    Valid values[ "CUSTOMER" ]
    id
    string

    The unique identifier of the customer

    email
    string (email)

    The email address of the customer

    firstName
    string

    The first name of the customer

    lastName
    string

    The last name of the customer

    createdAt
    string (date-time)

    The date and time the customer was created

    updatedAt
    string (date-time)

    The date and time the customer was last updated

    phone
    string

    The phone number of the customer

    addresses
    Array of object

    The addresses of the customer

    Min items1
    object
    id
    string

    The unique identifier of the address

    type
    string

    The type of the object

    Valid values[ "ADDRESS" ]
    createdAt
    string (date-time)

    The date and time the address was created

    updatedAt
    string (date-time)

    The date and time the address was last updated

    line1
    string

    The first line of the address

    line2
    string

    The second line of the address

    line3
    string

    The third line of the address

    city
    string

    The city of the address

    province
    string

    The province of the address

    postalCode
    string

    The postal code of the address

    country
    string

    The country of the address

    meta
    object

    The meta data of the customer

    meta
    object
    pagination
    object
    cursor
    string

    The cursor to start returning the results.

    nextCursor
    string

    Next page cursor.

    400

    Invalid Request

    Expand All
    object
    meta
    object

    Additional information about the error.

    errors
    Array of object

    A list of causes for the error.

    object
    status
    string

    The HTTP status code of the error.

    title
    string

    A short, human-readable summary of the problem.

    detail
    string

    A human-readable explanation specific to this occurrence of the problem.

    source
    object

    The source of the error.

    pointer
    string

    A JSON Pointer to the location in the request that caused the error.

    parameter
    string

    The parameter in the request that caused the error.

    header
    string

    The header in the request that caused the error.

    meta
    object

    Additional information about the error.

    401

    Invalid Authentication Credentials

    Expand All
    object
    meta
    object

    Additional information about the error.

    errors
    Array of object

    A list of causes for the error.

    object
    status
    string

    The HTTP status code of the error.

    title
    string

    A short, human-readable summary of the problem.

    detail
    string

    A human-readable explanation specific to this occurrence of the problem.

    source
    object

    The source of the error.

    pointer
    string

    A JSON Pointer to the location in the request that caused the error.

    parameter
    string

    The parameter in the request that caused the error.

    header
    string

    The header in the request that caused the error.

    meta
    object

    Additional information about the error.

    403

    Invalid Authorization Credentials

    Expand All
    object
    meta
    object

    Additional information about the error.

    errors
    Array of object

    A list of causes for the error.

    object
    status
    string

    The HTTP status code of the error.

    title
    string

    A short, human-readable summary of the problem.

    detail
    string

    A human-readable explanation specific to this occurrence of the problem.

    source
    object

    The source of the error.

    pointer
    string

    A JSON Pointer to the location in the request that caused the error.

    parameter
    string

    The parameter in the request that caused the error.

    header
    string

    The header in the request that caused the error.

    meta
    object

    Additional information about the error.

    500

    Internal Server Error

    Expand All
    object
    meta
    object

    Additional information about the error.

    errors
    Array of object

    A list of causes for the error.

    object
    status
    string

    The HTTP status code of the error.

    title
    string

    A short, human-readable summary of the problem.

    detail
    string

    A human-readable explanation specific to this occurrence of the problem.

    source
    object

    The source of the error.

    pointer
    string

    A JSON Pointer to the location in the request that caused the error.

    parameter
    string

    The parameter in the request that caused the error.

    header
    string

    The header in the request that caused the error.

    meta
    object

    Additional information about the error.

    Was this article helpful?
    What's Next