Skip to main content

List Organizations

GET 
/api/v1/organizations

List Organizations

Request​

Query Parameters

    offset integer

    Default value: 0

    limit integer

    Possible values: >= 1 and <= 100

    Default value: 10

    Limit result of list

    name string

    Filter organizations by name

Responses​

OK

Schema

    data

    object[]

    Organizations data

  • Array [

    • address stringrequired

    Possible values: non-empty

    Organization address line 1

    address2 string

    Organization address line 2

    billing_email stringnullable

    Billing email

    city stringnullable

    City where the organization locates

    contacts

    object[]

    required

    Possible values: >= 1

    Organization contact information

  • Array [

    • email string

    Email of the organization contact

    firstName stringrequired

    Possible values: non-empty

    First name of the organization contact

    lastName stringnullable

    Last name of the organization contact

    phone stringnullable

    Phone number of the organization contact

    workPhone string

    Work phone number of the organization contact

  • ]

    • country stringrequired

    ISO Alpha-2 country code

    createdAt string

    Creation date and time of the organization in the system

    id string
    linkedId stringnullable
    linkedTo string

    Global organization that links to this local organization

    location

    object

    nullable

    Organization location

    latitude numberrequired

    Latitude of the organization location

    longitude numberrequired

    Longitude of the organization location

    name stringrequired

    Possible values: non-empty

    Name of the organization

    phone stringrequired

    Possible values: non-empty

    Organization phone number

    postal stringnullable

    Organization postal code

    province stringnullable

    Province where the organization locates

    type stringrequired

    Possible values: non-empty

    Support F(Factory) S(Supplier) B(Brand) R(Retailer) V(Vendor)

    updatedAt string

    Last updated date and time of the organization in the system

    description stringnullable

    description of the local organization

  • ]

    • limit integerrequired
    offset integerrequired
    total integerrequired
Loading...