Skip to main content

Get Organizations 

GET 
/organizations

This operation allows to get a page of Organization

Request​

Query Parameters

    limit int32

    Limit of the page

    offset int32

    Offset of the page

Responses​

ok

Response Headers

  • X-Total-Count

    integer

    total count of organizations

  • X-Result-Count

    integer

    organizations result count

Schema

  • Array [

    • id uuid

    Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

    organization id

    name string

    organization name

    customerId string

    customer id

    customerAddress string

    customer address

    type string

    organization type

    installedOfferList

    object[]

    list of installed offer associated to an organization

  • Array [

    • code stringrequired

    Possible values: Value must match regular expression \S

    installed offer code

    name stringrequired

    Possible values: Value must match regular expression \S

    installed offer name

  • ]

    • salesContactName string

    sales contact name

    salesContactEmail string

    sales contact email

    tanid int32

    tan id

    contractid int32

    contract id

    saleschannel string

    sales channel

    banIds int32[]

    list of ban ids associated to an organization

    linkedCustomerIds string[]

    list of linked customer ids associated to an organization

  • ]

Loading...