api

Find agency

get

Retrieve one agency by id

Path parameters

idstringRequired

Responses

200Success

application/json

idstringRequired

Id of the response

Example: 2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231

createdAtstring · date-timeRequired

IdResponse creation date

Example: 2020-11-24T17:43:15.970Z

updatedAtstring · date-timeRequired

IdResponse updated date

Example: 2020-11-24T17:43:15.970Z

namestringRequired

Agency firstname

Example: We Invest Name

royaltyFeenumberRequired

Agency lastname

Example: 0.12

activityScopestring · enumRequired

Agency activity scope

Example: EXISTINGPossible values:

preferredLocalestring · enumRequired

Agency preferred locale

Example: DE_DEPossible values:

masterFranchiseIdstringRequired

Agency master franchise id

Example: d2af2af1-e3ea-4afc-93d8-77fd269d720c

emailstringRequired

Agency email

Example: [email protected]

onboardingChecklistSheetUrlstringOptional

Agency onboarding checklist sheet url

Example: 1EhShSV33ks5LQelZeqH0dWPyL3etq66seWDWkEdXiJs

onboardingFollowUpSheetUrlobjectOptional

Agency onboarding follow up sheet url

Example: 1EhShSV33ks5LQelZeqH0dWPyL3etq66seWDWkEdXiJs

advertisingPhoneNumberstringOptional

Advertising phone number

Example: [phone]

advertisingEmailstringOptional

Advertising email

Example: [email protected]

membershipAmountnumberRequired

Membership amount of the agency

Example: 170

get

/v1/agencies/{id}

HTTPcURLJavaScriptPython

GET /v1/agencies/{id} HTTP/1.1
Accept: */*

200Success

{
  "id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231",
  "createdAt": "2020-11-24T17:43:15.970Z",
  "updatedAt": "2020-11-24T17:43:15.970Z",
  "name": "We Invest Name",
  "royaltyFee": 0.12,
  "activityScope": "EXISTING",
  "preferredLocale": "DE_DE",
  "masterFranchiseId": "d2af2af1-e3ea-4afc-93d8-77fd269d720c",
  "email": "[email protected]",
  "phoneNumbers": [
    {
      "value": "495 22 11 22",
      "isDefault": false
    }
  ],
  "address": {
    "street": "Place Communale d'Auderghem",
    "number": "8",
    "floor": "2",
    "box": "B",
    "postalCode": "1160",
    "city": "Auderghem",
    "country": "BE"
  },
  "invites": [
    {
      "id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231",
      "createdAt": "2020-11-24T17:43:15.970Z",
      "updatedAt": "2020-11-24T17:43:15.970Z",
      "email": "[email protected]",
      "firstDay": "2023-12-31",
      "locale": "DE_DE",
      "agencies": [
        {
          "agency": "[Circular Reference]",
          "agencyId": "3cdd1d86-b543-47c1-b3d7-9be0863f4381",
          "activityScope": "EXISTING",
          "isDefault": true,
          "isDirector": true
        }
      ],
      "expiryDate": "2023-12-31",
      "acceptedAt": "2023-12-31",
      "titleId": "dfee62cb-08f2-4b66-83ee-1b8880794d48",
      "title": {
        "id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231",
        "slug": "admin_assistant",
        "role": "ADMIN",
        "translations": [
          {
            "locale": "DE_DE",
            "masculine": "Administrator",
            "feminine": "Administrator",
            "neutral": "Administrator"
          }
        ]
      }
    }
  ],
  "memberAgencies": [
    {
      "createdAt": "2020-11-24T17:43:15.970Z",
      "updatedAt": "2020-11-24T17:43:15.970Z",
      "joinedDate": "2020-11-24T17:43:15.970Z",
      "agencyId": "15dbb114-3bfd-47d2-b55f-ae12f789df20",
      "agency": {
        "id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231",
        "createdAt": "2020-11-24T17:43:15.970Z",
        "updatedAt": "2020-11-24T17:43:15.970Z",
        "name": "We Invest Name",
        "royaltyFee": 0.12,
        "activityScope": "EXISTING",
        "preferredLocale": "DE_DE",
        "masterFranchiseId": "d2af2af1-e3ea-4afc-93d8-77fd269d720c",
        "email": "[email protected]",
        "phoneNumbers": [
          {
            "value": "495 22 11 22",
            "isDefault": false
          }
        ],
        "address": {
          "street": "Place Communale d'Auderghem",
          "number": "8",
          "floor": "2",
          "box": "B",
          "postalCode": "1160",
          "city": "Auderghem",
          "country": "BE"
        },
        "invites": [
          {
            "id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231",
            "createdAt": "2020-11-24T17:43:15.970Z",
            "updatedAt": "2020-11-24T17:43:15.970Z",
            "email": "[email protected]",
            "firstDay": "2023-12-31",
            "locale": "DE_DE",
            "agencies": [
              {
                "agency": "[Circular Reference]",
                "agencyId": "3cdd1d86-b543-47c1-b3d7-9be0863f4381",
                "activityScope": "EXISTING",
                "isDefault": true,
                "isDirector": true
              }
            ],
            "expiryDate": "2023-12-31",
            "acceptedAt": "2023-12-31",
            "titleId": "dfee62cb-08f2-4b66-83ee-1b8880794d48",
            "title": {
              "id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231",
              "slug": "admin_assistant",
              "role": "ADMIN",
              "translations": [
                {
                  "locale": "DE_DE",
                  "masculine": "Administrator",
                  "feminine": "Administrator",
                  "neutral": "Administrator"
                }
              ]
            }
          }
        ],
        "memberAgencies": [
          {
            "createdAt": "2020-11-24T17:43:15.970Z",
            "updatedAt": "2020-11-24T17:43:15.970Z",
            "joinedDate": "2020-11-24T17:43:15.970Z",
            "agencyId": "15dbb114-3bfd-47d2-b55f-ae12f789df20",
            "agency": "[Circular Reference]",
            "memberId": "15dbb114-3bfd-47d2-b55f-ae12f789df20",
            "member": {
              "id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231",
              "createdAt": "2020-11-24T17:43:15.970Z",
              "updatedAt": "2020-11-24T17:43:15.970Z",
              "firstName": "John",
              "lastName": "Doe",
              "gender": "MALE",
              "avatar": "https://an-url.com/image.jpg",
              "phoneNumber": "[phone]",
              "birthDate": "2000-01-01",
              "joinedDate": "2023-08-01",
              "certNumber": "CERT123",
              "address": {
                "street": "Place Communale d'Auderghem",
                "number": "8",
                "floor": "2",
                "box": "B",
                "postalCode": "1160",
                "city": "Auderghem",
                "country": "BE"
              },
              "emails": [],
              "pictures": [
                {
                  "memberId": "e487d30e-4861-4524-9d39-f0e6304e9152",
                  "type": "[email protected]",
                  "url": "http://close-ferry.net"
                }
              ],
              "billingCompanyId": "abc123",
              "billingCompany": {},
              "agencies": [
                []
              ],
              "titleId": "dfee62cb-08f2-4b66-83ee-1b8880794d48",
              "title": {},
              "advertisingPhoneNumber": "[phone]",
              "advertisingEmail": "[email protected]",
              "whiseUser": {
                "id": "text",
                "accountId": "text",
                "memberId": "text"
              },
              "masterFranchises": [
                {
                  "id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231",
                  "createdAt": "2020-11-24T17:43:15.970Z",
                  "updatedAt": "2020-11-24T17:43:15.970Z",
                  "defaultFee": 0.3,
                  "address": {
                    "street": "Place Communale d'Auderghem",
                    "number": "8",
                    "floor": "2",
                    "box": "B",
                    "postalCode": "1160",
                    "city": "Auderghem",
                    "country": "BE"
                  },
                  "name": "Belgium",
                  "memberTitles": [
                    {
                      "id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231",
                      "slug": "admin_assistant",
                      "role": "ADMIN",
                      "translations": [
                        {
                          "locale": "DE_DE",
                          "masculine": "Administrator",
                          "feminine": "Administrator",
                          "neutral": "Administrator"
                        }
                      ]
                    }
                  ],
                  "locales": [
                    {
                      "masterFranchiseId": "abd1b7f6-1ffe-4a1e-8d4f-5381b6df86dc",
                      "locale": "EN_BE",
                      "isPreferred": true
                    }
                  ],
                  "billingAccount": {
                    "id": "8138e715-4214-4d63-8aef-25ed2346fdd6",
                    "preferredDepartmentId": "8138e715-4214-4d63-8aef-25ed2346fdd6",
                    "preferredTaxRateId": "8138e715-4214-4d63-8aef-25ed2346fdd6"
                  }
                }
              ]
            },
            "isDefault": true,
            "isDirector": true,
            "activityScope": "EXISTING"
          }
        ],
        "billingAccount": {
          "id": "8138e715-4214-4d63-8aef-25ed2346fdd6",
          "preferredDepartmentId": "8138e715-4214-4d63-8aef-25ed2346fdd6",
          "preferredTaxRateId": "8138e715-4214-4d63-8aef-25ed2346fdd6"
        },
        "onboardingChecklistSheetUrl": "1EhShSV33ks5LQelZeqH0dWPyL3etq66seWDWkEdXiJs",
        "onboardingFollowUpSheetUrl": "1EhShSV33ks5LQelZeqH0dWPyL3etq66seWDWkEdXiJs",
        "franchisee": {
          "id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231",
          "createdAt": "2020-11-24T17:43:15.970Z",
          "updatedAt": "2020-11-24T17:43:15.970Z",
          "billingCompanyId": "7345a320-130d-4f81-ab8e-25bdea7d6738",
          "billingCompany": {
            "id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231",
            "createdAt": "2020-11-24T17:43:15.970Z",
            "updatedAt": "2020-11-24T17:43:15.970Z",
            "address": {
              "street": "Place Communale d'Auderghem",
              "number": "8",
              "floor": "2",
              "box": "B",
              "postalCode": "1160",
              "city": "Auderghem",
              "country": "BE"
            },
            "vatNumber": "text",
            "legalName": "text",
            "email": "text",
            "phoneNumber": "text",
            "preferredLocale": "DE_DE"
          }
        },
        "whiseOffice": {
          "id": "text",
          "agencyId": "text",
          "whiseAccountId": "text"
        },
        "geodata": [
          {
            "geodataCode": "text",
            "zone": "ONE"
          }
        ],
        "socialMedia": {
          "facebookUrl": "https://www.facebook.com/profile.php?id=100057169311342",
          "instagramUrl": "https://www.instagram.com/we_invest_charleroi/",
          "websiteUrl": "https://weinvest.be/fr-BE/agencies/charleroi/7"
        },
        "googleIds": {
          "googleMyBusinessId": "text",
          "googleMyBusinessLocationId": "text",
          "googleMapsPlaceId": "text"
        },
        "advertisingPhoneNumber": "[phone]",
        "advertisingEmail": "[email protected]",
        "membershipAmount": 170
      },
      "memberId": "15dbb114-3bfd-47d2-b55f-ae12f789df20",
      "member": {
        "id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231",
        "createdAt": "2020-11-24T17:43:15.970Z",
        "updatedAt": "2020-11-24T17:43:15.970Z",
        "firstName": "John",
        "lastName": "Doe",
        "gender": "MALE",
        "avatar": "https://an-url.com/image.jpg",
        "phoneNumber": "[phone]",
        "birthDate": "2000-01-01",
        "joinedDate": "2023-08-01",
        "certNumber": "CERT123",
        "address": {
          "street": "Place Communale d'Auderghem",
          "number": "8",
          "floor": "2",
          "box": "B",
          "postalCode": "1160",
          "city": "Auderghem",
          "country": "BE"
        },
        "emails": [],
        "pictures": [
          {
            "memberId": "e487d30e-4861-4524-9d39-f0e6304e9152",
            "type": "[email protected]",
            "url": "http://close-ferry.net"
          }
        ],
        "billingCompanyId": "abc123",
        "billingCompany": {},
        "agencies": [
          []
        ],
        "titleId": "dfee62cb-08f2-4b66-83ee-1b8880794d48",
        "title": {},
        "advertisingPhoneNumber": "[phone]",
        "advertisingEmail": "[email protected]",
        "whiseUser": {
          "id": "text",
          "accountId": "text",
          "memberId": "text"
        },
        "masterFranchises": [
          {
            "id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231",
            "createdAt": "2020-11-24T17:43:15.970Z",
            "updatedAt": "2020-11-24T17:43:15.970Z",
            "defaultFee": 0.3,
            "address": {
              "street": "Place Communale d'Auderghem",
              "number": "8",
              "floor": "2",
              "box": "B",
              "postalCode": "1160",
              "city": "Auderghem",
              "country": "BE"
            },
            "name": "Belgium",
            "memberTitles": [
              {
                "id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231",
                "slug": "admin_assistant",
                "role": "ADMIN",
                "translations": [
                  {
                    "locale": "DE_DE",
                    "masculine": "Administrator",
                    "feminine": "Administrator",
                    "neutral": "Administrator"
                  }
                ]
              }
            ],
            "locales": [
              {
                "masterFranchiseId": "abd1b7f6-1ffe-4a1e-8d4f-5381b6df86dc",
                "locale": "EN_BE",
                "isPreferred": true
              }
            ],
            "billingAccount": {
              "id": "8138e715-4214-4d63-8aef-25ed2346fdd6",
              "preferredDepartmentId": "8138e715-4214-4d63-8aef-25ed2346fdd6",
              "preferredTaxRateId": "8138e715-4214-4d63-8aef-25ed2346fdd6"
            }
          }
        ]
      },
      "isDefault": true,
      "isDirector": true,
      "activityScope": "EXISTING"
    }
  ],
  "billingAccount": {
    "id": "8138e715-4214-4d63-8aef-25ed2346fdd6",
    "preferredDepartmentId": "8138e715-4214-4d63-8aef-25ed2346fdd6",
    "preferredTaxRateId": "8138e715-4214-4d63-8aef-25ed2346fdd6"
  },
  "onboardingChecklistSheetUrl": "1EhShSV33ks5LQelZeqH0dWPyL3etq66seWDWkEdXiJs",
  "onboardingFollowUpSheetUrl": "1EhShSV33ks5LQelZeqH0dWPyL3etq66seWDWkEdXiJs",
  "franchisee": {
    "id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231",
    "createdAt": "2020-11-24T17:43:15.970Z",
    "updatedAt": "2020-11-24T17:43:15.970Z",
    "billingCompanyId": "7345a320-130d-4f81-ab8e-25bdea7d6738",
    "billingCompany": {
      "id": "2cdc8ab1-6d50-49cc-ba14-54e4ac7ec231",
      "createdAt": "2020-11-24T17:43:15.970Z",
      "updatedAt": "2020-11-24T17:43:15.970Z",
      "address": {
        "street": "Place Communale d'Auderghem",
        "number": "8",
        "floor": "2",
        "box": "B",
        "postalCode": "1160",
        "city": "Auderghem",
        "country": "BE"
      },
      "vatNumber": "text",
      "legalName": "text",
      "email": "text",
      "phoneNumber": "text",
      "preferredLocale": "DE_DE"
    }
  },
  "whiseOffice": {
    "id": "text",
    "agencyId": "text",
    "whiseAccountId": "text"
  },
  "geodata": [
    {
      "geodataCode": "text",
      "zone": "ONE"
    }
  ],
  "socialMedia": {
    "facebookUrl": "https://www.facebook.com/profile.php?id=100057169311342",
    "instagramUrl": "https://www.instagram.com/we_invest_charleroi/",
    "websiteUrl": "https://weinvest.be/fr-BE/agencies/charleroi/7"
  },
  "googleIds": {
    "googleMyBusinessId": "text",
    "googleMyBusinessLocationId": "text",
    "googleMapsPlaceId": "text"
  },
  "advertisingPhoneNumber": "[phone]",
  "advertisingEmail": "[email protected]",
  "membershipAmount": 170
}