Jump to

• Request
• Response

Get organizations.

get

/connectedWorker/clientapi/v2/orgs

This operation retrieves organizations.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Organizations were successfully retrieved.

Body ()

Root Schema : OrganizationsRep

Type: object

Show Source

• items: array items
• links(optional): array links
  Read Only: true

{
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Organization"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Organization

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Organization"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Organization

Type: object

Show Source

• description(optional): string
  Detailed information about the organization

  Example: My company project
• id(optional): string
  Read Only: true

  The unique id of the object

  Example: 53
• links(optional): array links
• name: string
  Minimum Length: 0

  Maximum Length: 255

  Name of the organization, cannot be blank, max length is 255 characters

  Example: My organization name
• system(optional): boolean
  Read Only: true

  Flag indicating that the organization is system one

  Example: false

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique id of the object",
            "readOnly":true,
            "example":"53"
        },
        "name":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Name of the organization, cannot be blank, max length is 255 characters",
            "example":"My organization name"
        },
        "description":{
            "type":"string",
            "description":"Detailed information about the organization",
            "example":"My company project"
        },
        "system":{
            "type":"boolean",
            "description":"Flag indicating that the organization is system one",
            "readOnly":true,
            "example":false
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
  The target resource's URI
• rel: string
  Relation type

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relation type"
        },
        "href":{
            "type":"string",
            "description":"The target resource's URI"
        }
    }
}

Back to Top