Get a Folder by Type

import requests
url = "https://app.brightmove.com/ATS/app/folder/get/1/1"
payload = {}
headers = {"Content-Type": "application/json"}
response = requests.get(url, json=payload, headers=headers)
print(response.json())

{
  "folderGk": 9876543210,
  "folderName": "Engineering Team Documents",
  "shared": true,
  "owned": false,
  "createDate": "2024-05-20T09:15:00Z",
  "owner": {
    "userGk": 1234567890,
    "guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "salutation": {
      "id": 1,
      "name": "Mr."
    },
    "firstName": "James",
    "middleName": "A.",
    "lastName": "Smith",
    "nickname": "Jim",
    "email": "james.smith@example.com",
    "workEmail": "j.smith@brightmove.com",
    "type": {
      "id": 2,
      "name": "Administrator"
    },
    "companyGk": 555555,
    "companyName": "BrightMove Inc.",
    "companyGuid": "comp-1234-5678-9012-3456",
    "createUserGk": 111111,
    "modifyUserGk": 222222,
    "username": "jsmith",
    "avatarUrl": "https://cdn.brightmove.com/avatars/jsmith.png",
    "timezoneId": -5,
    "localeId": 1033,
    "statusId": 1,
    "phones": [
      {
        "id": 1001,
        "phoneNumber": "+1-555-123-4567",
        "type": {
          "id": 1,
          "name": "Mobile",
          "sortOrder": 1,
          "choice": true
        },
        "userGk": 1234567890
      }
    ],
    "primary": true,
    "createUser": {
      "userGk": 111111,
      "guid": "11111111-2222-3333-4444-555555555555",
      "salutation": {
        "id": 2,
        "name": "Ms."
      },
      "firstName": "Anna",
      "middleName": "B.",
      "lastName": "Johnson",
      "nickname": "Ann",
      "email": "anna.johnson@example.com",
      "workEmail": "a.johnson@brightmove.com",
      "type": {
        "id": 3,
        "name": "User"
      },
      "companyGk": 555555,
      "companyName": "BrightMove Inc.",
      "companyGuid": "comp-1234-5678-9012-3456",
      "createUserGk": 0,
      "modifyUserGk": 0,
      "username": "ajohnson",
      "avatarUrl": "https://cdn.brightmove.com/avatars/ajohnson.png",
      "timezoneId": -5,
      "localeId": 1033,
      "statusId": 1,
      "displayFullName": "Anna B. Johnson",
      "displayName": "Anna Johnson",
      "displayNameLastFirst": "Johnson, Anna",
      "bestEmail": "anna.johnson@example.com"
    },
    "modifyUser": {
      "userGk": 222222,
      "guid": "22222222-3333-4444-5555-666666666666",
      "salutation": {
        "id": 1,
        "name": "Mr."
      },
      "firstName": "Robert",
      "middleName": "C.",
      "lastName": "Williams",
      "nickname": "Rob",
      "email": "robert.williams@example.com",
      "workEmail": "r.williams@brightmove.com",
      "type": {
        "id": 2,
        "name": "Administrator"
      },
      "companyGk": 555555,
      "companyName": "BrightMove Inc.",
      "companyGuid": "comp-1234-5678-9012-3456",
      "createUserGk": 111111,
      "modifyUserGk": 111111,
      "username": "rwilliams",
      "avatarUrl": "https://cdn.brightmove.com/avatars/rwilliams.png",
      "timezoneId": -5,
      "localeId": 1033,
      "statusId": 1,
      "displayFullName": "Robert C. Williams",
      "displayName": "Robert Williams",
      "displayNameLastFirst": "Williams, Robert",
      "bestEmail": "robert.williams@example.com"
    },
    "createDate": "2023-11-01T08:00:00Z",
    "modifyDate": "2024-04-15T16:45:00Z",
    "themeGk": 10,
    "lookDate": "2024-05-01T00:00:00Z",
    "unsubscribeDate": null,
    "delegates": [],
    "emailSignature": "Best regards,\nJames Smith\nBrightMove Inc.",
    "name": "James Smith",
    "displayFullName": "James A. Smith",
    "displayName": "James Smith",
    "displayNameLastFirst": "Smith, James",
    "bestEmail": "james.smith@example.com"
  },
  "entityType": {
    "id": 1,
    "name": "Candidate"
  },
  "memberCount": 42
}

Path parameters

entityTypeintegerRequired

folderGklongRequired

Path parameters

Headers

Response