Jump to

• Request
• Response

Retrieve an Organization

get

/api/v2/organizations/{id}/

Make GET request to this resource to retrieve a single organization record containing the following fields:

• id: Database ID for this organization. (integer)
• type: Data type for this organization. (choice)
• url: URL for this organization. (string)
• related: Data structure with URLs of related resources. (object)
• summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
• created: Timestamp when this organization was created. (datetime)
• modified: Timestamp when this organization was last modified. (datetime)
• name: Name of this organization. (string)
• description: Optional description of this organization. (string)
• max_hosts: Maximum number of hosts allowed to be managed by this organization. (integer)
• custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
• default_environment: The default execution environment for jobs run by this organization. (id)

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : Organization

Type: object

Show Source

• created: string
  Title: Created

  Read Only: true
• custom_virtualenv: string
  Title: Custom virtualenv

  Read Only: true

  Minimum Length: 1

  Local absolute file path containing a custom Python virtualenv to use
• default_environment: integer
  Title: Default environment

  The default execution environment for jobs run by this organization.
• description: string
  Title: Description
• id: integer
  Title: ID

  Read Only: true
• max_hosts: integer
  Title: Max hosts

  Minimum Value: 0

  Maximum number of hosts allowed to be managed by this organization.
• modified: string
  Title: Modified

  Read Only: true
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 512
• related: string
  Title: Related

  Read Only: true
• summary_fields: string
  Title: Summary fields

  Read Only: true
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: true

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "custom_virtualenv":{
            "description":"Local absolute file path containing a custom Python virtualenv to use",
            "minLength":"1",
            "readOnly":true,
            "title":"Custom virtualenv",
            "type":"string",
            "x-nullable":true
        },
        "default_environment":{
            "description":"The default execution environment for jobs run by this organization.",
            "title":"Default environment",
            "type":"integer",
            "x-nullable":true
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "max_hosts":{
            "description":"Maximum number of hosts allowed to be managed by this organization.",
            "minimum":"0",
            "title":"Max hosts",
            "type":"integer"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

Back to Top