Skip to main content

Lists the Business Identities owned by the current user/organization

GET 

/business_identities

Lists the Business Identities owned by the current user/organization

Request

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

Responses

200: Successful response with a list of Business Identities.

Schema

    data

    object[]

  • Array [

  • record_type string
    id uuid
    organization_id uuid

    The ID of the organization that owns the record

    name string

    The name of the business identity on the telnyx platform

    business_email string

    The email of the business

    business_name string

    The name of the business

    business_phone_number string
    business_description string
    submission_acknowledgement boolean

    User acceptance of the terms of submission

    website_url string[]

    address

    object

    The primary address of the business

    record_type string
    id uuid
    city string
    country string
    extended_address string
    postal_code string
    state string
    street string

    contacts

    object[]

  • Array [

  • record_type string
    id uuid
    email string
    first_name string
    job_title string
    last_name string
    phone_number string
  • ]

  • created_at datetime

    An ISO 8601 datetime string for when the business identity was added to the Telnyx platform

    updated_at datetime

    An ISO 8601 datetime string for when the business identity was updated

  • ]

  • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

  • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which parameter caused the error.

    meta

    object

    url string

    URL with additional information on the error.

  • ]

Loading...