Returns all delivery regions available to your organization
    • 11 Oct 2024
    • 1 Minute to read

    Returns all delivery regions available to your organization


    Article summary

    Get
    /deliveryregions

    The DeliveryRegions command will return all delivery regions available to your organization.
    NOTE: there are no query parameters for this command.

    Security
    API Key
    Header parameter nameapi_key

    All methods require an API key, which must be obtained from Skillable. This key is used by Skillable to validate your account. The key can be passed as an HTTP request header with the header name "api_key".

    Responses
    200

    OK Response.

    Example of a successful response listing all delivery regions available to your organization
    {
      "DeliveryRegions": [
        {
          "Id": 1,
          "Name": "North America",
          "Description": "North American datacenters."
        },
        {
          "Id": 2,
          "Name": "Australia",
          "Description": null
        }
      ],
      "Status": 1,
      "Error": null
    }
    Expand All
    object
    DeliveryRegions
    Array of object

    Array of DeliveryRegion objects.

    object
    Id
    integer

    The unique identifier of the delivery region.

    Name
    string

    The name of the delivery region.

    Description
    string | null

    A brief description of the delivery region.

    Status
    integer

    Indicates the status of the API request.
    0 = Error
    1 = Success

    Error
    string | null

    In the event of an error, this will contain a detailed error message.


    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.