Organization API

Query String

• Optional

  • ~name ⁠string
    Filters the list by a name pattern.
    Example: *lice
    Example: alic*
  • name ⁠string
    Filters the list by exact name.
  • permission ⁠string
    Filters the list by the permission the authenticated user has on that organization and products in it.
  • sort_by ⁠string

    One of: "name", "type", "id"

    Default: "name"

    Used to specify how you want the results sorted.
  • type ⁠string

    One of: "individual", "company", "association", "publicbody"

    Filters the list by type of organization.

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
    Example: Bearer pat_abc-123
    Example: Apikey your-api-key

Body

• application/json

  ⁠array

  Of items of type:

  • object

    With the following properties:

    • id ⁠string
      The main identifier of the organization. Also known as sharing_id in many routes.
    • name ⁠string
      Unique name of the organization.

    Optional

    • corporate ⁠boolean
      Flag to indicate the corporate status for the organization.
    • email ⁠string
      The email address of the organization.
    • firstname ⁠string
      The first name of the organization.
    • lastname ⁠string
      The last name of the organization.
    • orgname ⁠string
      The company, association, or public body name of the (non-individual) organization.
    • reseller ⁠boolean
      Flag to indicate the reseller status for the organization.
    • siren ⁠string
      The siren number of the (non-individual) organization.
    • type ⁠string
      The type of the organization.
    • vat_number ⁠string
      The VAT number of the (non-individual) organization.
  Example:

  [
    {
      "name": "alice",
      "firstname": "Alice",
      "lastname": "Doe",
      "id": "80548b45-e18d-4cab-adef-e10a8406de4a",
      "reseller": false,
      "corporate": true,
      "type": "individual",
      "email": "alice@example.net"
    },
    {
      "name": "bob",
      "firstname": "Bob",
      "orgname": "Bob's Roads",
      "lastname": "Doe",
      "email": "bob@example.net",
      "reseller": false,
      "corporate": false,
      "type": "publicbody",
      "id": "e1ab1204-e638-4fd8-85a4-34dd95013cdc"
    },
    {
      "name": "ron",
      "firstname": "Ron",
      "orgname": "Ron Inc.",
      "lastname": "Doe",
      "email": "ron@example.net",
      "reseller": false,
      "corporate": false,
      "type": "company",
      "id": "b018061c-a4e3-4d6d-8445-e3837bd23815"
    }
  ]

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
    Example: Bearer pat_abc-123
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With the following properties:

  Required

  • city ⁠string
    the city name of the address.
  • email ⁠string
    The email address of the organization.
  • firstname ⁠string
    The first name of the organization.
  • lastname ⁠string
    The last name of the organization.
  • name ⁠string
    Unique name of the organization.
  • orgname ⁠string
    The company, association, or public body name of the organization.
  • phone ⁠string
    phone number.
  • streetaddr ⁠string
    the street address of the organization.
  • type ⁠string

    One of: "company", "association", "publicbody"

    The type of the organization.

  Optional

  • country ⁠string
    country ISO code of the address.
  • fax ⁠string
    fax number.
  • lang ⁠string
    language of the organization for emails.
  • reference ⁠string
    Optional text to display on the invoice, such as your own reference info.
  • reseller ⁠boolean
    Flag to set the organization as reseller.
  • siren ⁠string
    The siren number of the organization.
  • state ⁠string
    state ISO code of the address.
  • streetaddr2 ⁠string
    additional street address info of the organization.
  • vat_number ⁠string
    The VAT number of the organization.
  • zip ⁠string
    zip code of the address.
  Example:

  {
    "type": "company",
    "name": "Poppy Red LLC",
    "firstname": "John",
    "lastname": "Do",
    "orgname": "Poppy Red LLC",
    "email": "jd@example.net",
    "streetaddr": "42 Rue du Soleil Levant",
    "zip": "17000",
    "city": "La Rochelle",
    "country": "FR",
    "state": "FR-NAQ",
    "phone": "+33.612345678",
    "reseller": false
  }

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • id ⁠string
    Created Organization ID.
  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • org_id ⁠string
    Organization ID.

Body

• application/json

  ⁠object

  With the following properties:

  • city ⁠string
    the city name of the address.
  • corporate ⁠boolean
    Flag set for corporate organization.
  • country ⁠string
    country ISO code of the address.
  • email ⁠string
    the email address of the organization.
  • firstname ⁠string
    the first name of the organization.
  • id ⁠string
    the sharing id of the organization.
  • lastname ⁠string
    the last name of the organization.
  • name ⁠string
    the sharing name of the organization.
  • reseller ⁠boolean
    Flag set for reseller organization.
  • streetaddr ⁠string
    the street address of the organization.
  • type ⁠string

    One of: "individual", "company", "association", "publicbody"

    the type of the organization.
  • zip ⁠string
    zip code of the address.

  Optional

  • fax ⁠string
    fax number.
  • lang ⁠string
    language used to send emails to the organization.
  • orgname ⁠string
    organization legal name.
  • phone ⁠string
    phone number.
  • reference ⁠string
    Optional text to display on the invoice, such as your own reference info.
  • state ⁠string
    state ISO code of the address.
  • streetaddr2 ⁠string
    additional street address info of the organization.
  • vat_number ⁠string
    The VAT number of the organization.

URI Parameters

• • org_id ⁠string
    Organization ID.

Body

• application/json

  ⁠object

  With the following properties:

  Optional

  • city ⁠string
    the city name of the address.
  • country ⁠string
    country (ISO 3166-1 alpha-2) code of the address.
  • email ⁠string
    The email address of the organization.
  • fax ⁠string
    fax number.
  • firstname ⁠string
    The first name of the organization.
  • lang ⁠string

    One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"

    language code of the organization for emails.
  • lastname ⁠string
    The last name of the organization.
  • name ⁠string
    Unique name of the organization.
  • phone ⁠string
    phone number.
  • reference ⁠string
    Optional text to display on the invoice, such as your own reference info.
  • reseller ⁠boolean
    Set the organization as reseller if true, cannot be set to false.
  • siren ⁠string
    The siren number of the organization.
  • state ⁠string
    Country subdivisions(ISO 3166-2) of the address.
  • streetaddr ⁠string
    the street address of the organization.
  • streetaddr2 ⁠string
    additional street address info of the organization.
  • vat_number ⁠string
    The VAT number of the organization.
  • zip ⁠string
    zip (postal) code of the address.

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

URI Parameters

• • org_id ⁠string
    Organization ID.

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Explanation message.

URI Parameters

• • org_id ⁠string
    Organization ID.

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
    Example: Bearer pat_abc-123
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With the following properties:

  Required

  • action ⁠string

    One of: "release_resellee"

  • params ⁠object

    With the following properties:

    Required

    • id ⁠string
      Identifier of the customer to release
  Example:

  {
    "action": "release_resellee",
    "params": {
      "id": "000000000000-0000-0000-0000-000000000000"
    }
  }

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Accepted.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • org_id ⁠string
    Organization ID.

Query String

• Optional

  • name ⁠string
    Filters the list by name, with optional patterns.
    Example: *lice
    Example: alic*
  • page ⁠integer

    Default: 1

    Minimum: 1

    Which result page to retrieve. If the number is greater than the last page, an empty list is returned.
  • per_page ⁠integer

    Minimum: 1

    How many items to display per page.
  • permission ⁠string
    Filters the list by the permission the authenticated user has on that organization and products in it.
  • sort_by ⁠string

    One of: "name", "type", "id"

    Default: "name"

    Used to specify how you want the results sorted.

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
    Example: Bearer pat_abc-123
    Example: Apikey your-api-key

Headers

• • Total-Count ⁠integer
    Total number of items.

  Optional

  • Link ⁠string
    Links to next and last page.

Body

• application/json

  ⁠array

  Of items of type:

  • object

    With the following properties:

    • email ⁠string
      Email of the customer.
    • firstname ⁠string
      First name of the customer.
    • id ⁠string
      The main identifier of the customer. Also known as sharing_id in many routes.
    • lastname ⁠string
      Last name of the customer.
    • name ⁠string
      Name of the customer.
    • type ⁠string

      One of: "individual", "company", "association", "publicbody"

      Type of the customer organization.

    Optional

    • orgname ⁠string
      Organization legal name of the customer.
  Example:

  [
    {
      "id": "80548b45-e18d-4cab-adef-e10a8406de4a",
      "name": "alice",
      "firstname": "Alice",
      "lastname": "Doe",
      "type": "individual",
      "email": "alice@example.net"
    },
    {
      "id": "e1ab1204-e638-4fd8-85a4-34dd95013cdc",
      "name": "bob",
      "firstname": "Bob",
      "lastname": "Doe",
      "type": "publicbody",
      "orgname": "Bob's Roads",
      "email": "bob@example.net"
    },
    {
      "id": "b018061c-a4e3-4d6d-8445-e3837bd23815",
      "name": "ron",
      "firstname": "Ron",
      "lastname": "Doe",
      "type": "company",
      "orgname": "Ron Inc.",
      "email": "ron@example.net"
    }
  ]

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • org_id ⁠string
    Organization ID.

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
    Example: Bearer pat_abc-123
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With the following properties:

  Required

  • city ⁠string
  • country ⁠string
    Country code.
  • email ⁠string
  • firstname ⁠string
    First name.
  • lastname ⁠string
    Last name.
  • phone ⁠string
  • streetaddr ⁠string
    Street address.
  • type ⁠string

    One of: "individual", "company", "association", "publicbody"

    Type of the customer organization.

  Optional

  • fax ⁠string
  • orgname ⁠string
    Organization legal name.
  • reference ⁠string
    Optional text to display on the invoice, such as your own customer reference info.
  • state ⁠string
    State/Province/Region.
  • streetaddr2 ⁠string
    Apt. number, suite, building, etc.
  • zip ⁠string
    Postal (zip) code, see also https://en.wikipedia.org/wiki/List_of_postal_codes.
  Example:

  {
    "type": "company",
    "firstname": "John",
    "lastname": "Do",
    "orgname": "R&D",
    "email": "jd@example.net",
    "streetaddr": "21 jump street",
    "streetaddr2": "Appt31",
    "zip": "17137",
    "city": "Nieul-sur-mer",
    "country": "FR",
    "state": "FR-NAQ",
    "phone": "+33.612345678",
    "fax": "+33.612345699",
    "reference": "abc/3458"
  }

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • id ⁠string
    Created customer ID.
  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • org_id ⁠string
    Organization ID.
  • id ⁠string
    Customer ID.

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
    Example: Bearer pat_abc-123
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With the following properties:

  • city ⁠string
    the city name of the address.
  • country ⁠string
    country ISO code of the address.
  • email ⁠string
    Email of the customer.
  • firstname ⁠string
    First name of the customer.
  • id ⁠string
    The main identifier of the customer. Also known as sharing_id in many routes.
  • lastname ⁠string
    Last name of the customer.
  • name ⁠string
    Name of the customer.
  • streetaddr ⁠string
    the street address of the user.
  • type ⁠string

    One of: "individual", "company", "association", "publicbody"

    Type of the customer organization.

  Optional

  • fax ⁠string
    fax number.
  • orgname ⁠string
    Organization legal name of the customer.
  • phone ⁠string
    phone number.
  • reference ⁠string
    Optional text to display on the invoice, such as your own customer reference info.
  • state ⁠string
    state ISO code of the address.
  • streetaddr2 ⁠string
    additional street address info of the user.
  • zip ⁠string
    zip code of the address.
  Example:

  {
    "id": "80548b45-e18d-4cab-adef-e10a8406de4a",
    "name": "alice",
    "firstname": "Alice",
    "lastname": "Doe",
    "type": "individual",
    "email": "alice@example.net",
    "streetaddr": "5000 Fraise",
    "zip": "17540",
    "city": "Les Rivieres d'Anais",
    "country": "FR"
  }

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • org_id ⁠string
    Organization ID.
  • id ⁠string
    Customer ID.

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
    Example: Bearer pat_abc-123
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With the following properties:

  Optional

  • city ⁠string
    the city name of the address.
  • country ⁠string
    country (ISO 3166-1 alpha-2) code of the address.
  • email ⁠string
    The email address of the customer.
  • fax ⁠string
    fax number.
  • firstname ⁠string
    The first name of the customer; clients with type 'individual' cannot update their firstname.
  • lang ⁠string

    One of: "en", "es", "fr", "ja", "zh-hans", "zh-hant"

    language code of the organization for emails.
  • lastname ⁠string
    The last name of the customer; clients with type 'individual' cannot update their lastname.
  • phone ⁠string
    phone number of the customer.
  • reference ⁠string
    reference field written on every invoice.
  • siren ⁠string
    The siren number of the organization.
  • state ⁠string
    Country subdivisions (ISO 3166-2) of the address.
  • streetaddr ⁠string
    the street address of the customer.
  • streetaddr2 ⁠string
    additional street address info of the customer.
  • sync_contact_email ⁠string

    One of: "never", "match", "always"

    If the customer owns domains, the update of the email can automatically propagate the update of the email of the owners of domains. By default, the change is not propagated. If 'match' is chosen, the domains' owners that have the same email are updated, if 'always' is chosen, then the email is always updated.
  • vat_number ⁠string
    The VAT number of the organization.
  • zip ⁠string
    zip (postal) code of the address.
  Example:

  Update email with domain owners email

  {
    "email": "hello@example.net",
    "sync_contact_email": "match"
  }

  Example:

  Update the reference of the customer

  {
    "reference": "POPPYRED500"
  }

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • org_id ⁠string
    Organization ID.
  • id ⁠string
    Customer ID.

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
    Example: Bearer pat_abc-123
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Explanation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Bearer for access token, or Apikey depending of the authentication scheme. Apikey is deprecated and be replaced by personal access token.
    Example: Bearer pat_abc-123
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With the following properties:

  • city ⁠string
    the city name of the address.
  • email ⁠string
    the email address of the user.
  • id ⁠string
    the sharing id of the user.
  • lang ⁠string
    language used by the user.
  • name ⁠string
    the sharing name of the user.
  • username ⁠string
    the username of the user.

  Optional

  • country ⁠string
    country ISO code of the address.
  • fax ⁠string
    fax number.
  • firstname ⁠string
    the first name of the user.
  • lastname ⁠string
    the last name of the user.
  • phone ⁠string
    phone number.
  • state ⁠string
    state ISO code of the address.
  • streetaddr ⁠string
    the street address of the user.
  • streetaddr2 ⁠string
    additional street address info of the user.
  • zip ⁠string
    zip code of the address.
  Example:

  {
    "id": "ebfcd3cd-e014-4a3d-8216-6e342f227c3d",
    "username": "alice",
    "email": "alice@example.org",
    "name": "alice",
    "firstname": "Alice",
    "lastname": "Doe",
    "streetaddr": "5 rue neuve",
    "zip": "75001",
    "city": "Paris",
    "state": "FR-IDF",
    "country": "FR",
    "phone": "+33.123456789",
    "lang": "en"
  }

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string