Jump to

• Request
• Response
• Examples

Fetch all organizations

get

/rest/api/v1.3/attributes/organizations

Fetch a list of all organizations within the account.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Get Organizations

Type: object

Title: Get Organizations

Show Source

• attributes(optional): object attributes

{
    "title":"Get Organizations",
    "type":"object",
    "properties":{
        "attributes":{
            "type":"object",
            "properties":{
                "organizations":{
                    "type":"object",
                    "properties":{
                        "attributeValues":{
                            "description":"Value of the Attribute",
                            "type":"array",
                            "items":{
                                "$ref":"#/definitions/attribute"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : attributes

Type: object

Show Source

• organizations(optional): object organizations

{
    "type":"object",
    "properties":{
        "organizations":{
            "type":"object",
            "properties":{
                "attributeValues":{
                    "description":"Value of the Attribute",
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/attribute"
                    }
                }
            }
        }
    }
}

Nested Schema : organizations

Type: object

Show Source

• attributeValues(optional): array attributeValues
  Value of the Attribute

{
    "type":"object",
    "properties":{
        "attributeValues":{
            "description":"Value of the Attribute",
            "type":"array",
            "items":{
                "$ref":"#/definitions/attribute"
            }
        }
    }
}

Nested Schema : attributeValues

Type: array

Value of the Attribute

Show Source

• Array of: object attribute
  Title: attribute

{
    "description":"Value of the Attribute",
    "type":"array",
    "items":{
        "$ref":"#/definitions/attribute"
    }
}

Nested Schema : attribute

Type: object

Title: attribute

Show Source

• children(optional): array children
  Children of the Attribute
• id(optional): string
  ID of the attribute
• lineage(optional): string
  Description of the attribute's heirarchy
• name(optional): string
  Name of the attribute

{
    "type":"object",
    "title":"attribute",
    "properties":{
        "id":{
            "description":"ID of the attribute",
            "type":"string"
        },
        "name":{
            "description":"Name of the attribute",
            "type":"string"
        },
        "lineage":{
            "description":"Description of the attribute's heirarchy",
            "type":"string"
        },
        "children":{
            "description":"Children of the Attribute",
            "type":"array",
            "items":{
                "$ref":"#/definitions/attribute"
            }
        }
    }
}

Nested Schema : children

Type: array

Children of the Attribute

Show Source

• Array of: object attribute
  Title: attribute

{
    "description":"Children of the Attribute",
    "type":"array",
    "items":{
        "$ref":"#/definitions/attribute"
    }
}

Back to Top

Examples

Use this interface to fetch all organizations in your account. To learn more about Organizations in Responsys, see the Responsys Help Center.

Required request headers:

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>
Content-Type	application/json

Sample Request URL:

/rest/api/v1.3/attributes/organizations
	

Sample Response

{
  "attributes": {
    "organizations": {
      "attributeValues": [
        {
          "id": 7,
          "name": "Root",
          "lineage": "7:",
          "children": [
            {
              "id": 4000007,
              "name": "India",
              "lineage": "7:4000007:",
              "children": [
                {
                  "id": 4000027,
                  "name": "Karnataka",
                  "lineage": "7:4000007:4000027:",
                  "children": [
                    {
                      "id": 4000067,
                      "name": "Bangalore",
                      "lineage": "7:4000007:4000027:4000067:"
                    },
                    {
                      "id": 4000087,
                      "name": "Mysore",
                      "lineage": "7:4000007:4000027:4000087:"
                    }
                  ]
                },
                {
                  "id": 4000047,
                  "name": "Delhi",
                  "lineage": "7:4000007:4000047:"
                },
                {
                  "id": 8000107,
                  "name": "Tamil Nadu",
                  "lineage": "7:4000007:8000107:",
                  "children": [
                    {
                      "id": 8000127,
                      "name": "Chennai",
                      "lineage": "7:4000007:8000107:8000127:"
                    }
                  ]
                }
              ]
            },
            {
              "id": 27,
              "name": "Legacy",
              "lineage": "7:27:"
            },
            {
              "id": 8000007,
              "name": "US",
              "lineage": "7:8000007:",
              "children": [
                {
                  "id": 8000027,
                  "name": "New York",
                  "lineage": "7:8000007:8000027:",
                  "children": [
                    {
                      "id": 8000067,
                      "name": "Albany",
                      "lineage": "7:8000007:8000027:8000067:"
                    }
                  ]
                },
                {
                  "id": 8000047,
                  "name": "New Jersey",
                  "lineage": "7:8000007:8000047:",
                  "children": [
                    {
                      "id": 8000087,
                      "name": "Trenton",
                      "lineage": "7:8000007:8000047:8000087:"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  }
}
	

Back to Top