---
updatedAt: 2026-05-04T11:49:01.000Z
agentTools:
  projectIndex: https://docs.company.info/llms.txt
---

# Retrieve one branch profile in detail.

Fetches detailed information for a single branch, including identification, lifecycle, personnel, contact, and activities. Optional include allows compound documents with related resources.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "NL Organizations",
    "description": "The NL Organizations API provides search and profiling capabilities for organizations and their branches.\n",
    "version": "v0.1.0"
  },
  "servers": [
    {
      "url": "https://api.company.info",
      "description": "Production Server"
    }
  ],
  "security": [
    {
      "authToken": []
    },
    {
      "jwtAuth": []
    }
  ],
  "tags": [
    {
      "name": "Branches",
      "description": "Operations related to managing individual branch profiles."
    }
  ],
  "paths": {
    "/nl/organizations/profiles/v1/branches/{branch_id}": {
      "get": {
        "operationId": "getBranch",
        "tags": [
          "Branches"
        ],
        "summary": "Retrieve one branch profile in detail.",
        "description": "Fetches detailed information for a single branch, including identification, lifecycle, personnel, contact, and activities. Optional include allows compound documents with related resources.",
        "parameters": [
          {
            "$ref": "#/components/parameters/acceptLanguage"
          },
          {
            "$ref": "#/components/parameters/branchIdParam"
          },
          {
            "$ref": "#/components/parameters/include"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "X-Correlation-Id": {
                "$ref": "#/components/headers/X-Correlation-Id"
              }
            },
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Response"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "data": {
                          "type": "object",
                          "properties": {
                            "type": {
                              "type": "string",
                              "example": "branches"
                            },
                            "id": {
                              "type": "string"
                            },
                            "attributes": {
                              "$ref": "#/components/schemas/BranchesAttributes"
                            },
                            "relationships": {
                              "type": "object",
                              "required": [
                                "organization"
                              ],
                              "properties": {
                                "organization": {
                                  "$ref": "#/components/schemas/RelationshipToOne"
                                }
                              }
                            },
                            "links": {
                              "type": "object",
                              "properties": {
                                "self": {
                                  "type": "string",
                                  "format": "uri-reference"
                                }
                              }
                            }
                          }
                        },
                        "included": {
                          "type": "array",
                          "uniqueItems": true,
                          "items": {
                            "type": "object",
                            "required": [
                              "type",
                              "id"
                            ],
                            "properties": {
                              "type": {
                                "type": "string",
                                "example": "organizations"
                              },
                              "id": {
                                "type": "string"
                              },
                              "attributes": {
                                "type": "object",
                                "properties": {
                                  "name": {
                                    "type": "string",
                                    "example": "Company A"
                                  },
                                  "country": {
                                    "type": "string",
                                    "description": "The country code (e.g., NLD).",
                                    "example": "NLD"
                                  }
                                }
                              },
                              "links": {
                                "type": "object",
                                "properties": {
                                  "self": {
                                    "type": "string",
                                    "format": "uri-reference"
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "500": {
            "$ref": "#/components/responses/500"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "authToken": {
        "description": "API Key Authentication",
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY"
      },
      "jwtAuth": {
        "description": "JWT Authentication",
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "schemas": {
      "BranchesAttributes": {
        "type": "object",
        "properties": {
          "identifiers": {
            "type": "object",
            "properties": {
              "tradeRegister": {
                "type": "object",
                "properties": {
                  "system": {
                    "type": "string",
                    "description": "The source system of the identifier.",
                    "example": "tradeRegister"
                  },
                  "value": {
                    "type": "string",
                    "example": "123456780000"
                  }
                }
              }
            }
          },
          "isMain": {
            "type": "boolean",
            "example": true
          },
          "names": {
            "type": "object",
            "properties": {
              "main": {
                "type": "string",
                "example": "Test B.V."
              },
              "tradeNames": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "isActive": {
                      "type": "boolean",
                      "description": "Indicates if the tradename is currently in use.",
                      "example": false
                    },
                    "isMain": {
                      "type": "boolean",
                      "description": "Indicates if this is the primary tradename.",
                      "example": false
                    },
                    "name": {
                      "type": "string",
                      "description": "The tradename string.",
                      "example": "Test B.V."
                    }
                  }
                }
              }
            }
          },
          "lifecycle": {
            "type": "object",
            "properties": {
              "registration": {
                "type": "object",
                "properties": {
                  "isActive": {
                    "type": "boolean",
                    "example": true
                  },
                  "type": {
                    "type": "string",
                    "example": "registration"
                  },
                  "startDate": {
                    "type": "string",
                    "format": "date",
                    "description": "The date when the event started or occurred",
                    "example": "1234-05-06"
                  },
                  "endDate": {
                    "type": "string",
                    "format": "date",
                    "description": "Optional end date, e.g. for insolvency cases",
                    "example": "1234-05-06"
                  }
                }
              },
              "events": {
                "type": "object",
                "properties": {
                  "continuation": {
                    "type": "object",
                    "properties": {
                      "date": {
                        "type": "string",
                        "example": "1234-05-06"
                      },
                      "type": {
                        "type": "string",
                        "example": "continuation"
                      }
                    }
                  }
                }
              }
            }
          },
          "personnel": {
            "type": "object",
            "properties": {
              "fulltime": {
                "type": "object",
                "properties": {
                  "value": {
                    "type": "integer",
                    "example": 23
                  },
                  "class": {
                    "type": "object",
                    "properties": {
                      "code": {
                        "type": "string",
                        "example": "6"
                      },
                      "description": {
                        "type": "string"
                      }
                    }
                  }
                }
              },
              "parttime": {
                "type": "object",
                "properties": {
                  "value": {
                    "type": "integer",
                    "example": 23
                  },
                  "class": {
                    "type": "object",
                    "properties": {
                      "code": {
                        "type": "string",
                        "example": "6"
                      },
                      "description": {
                        "type": "string"
                      }
                    }
                  }
                }
              },
              "total": {
                "type": "object",
                "properties": {
                  "value": {
                    "type": "integer",
                    "example": 23
                  },
                  "class": {
                    "type": "object",
                    "properties": {
                      "code": {
                        "type": "string",
                        "example": "6"
                      },
                      "description": {
                        "type": "string"
                      }
                    }
                  }
                }
              },
              "source": {
                "type": "string",
                "description": "Source system from which employee data is retrieved.",
                "example": "tradeRegister"
              }
            }
          },
          "contact": {
            "type": "object",
            "properties": {
              "excludeFromMailing": {
                "type": "boolean",
                "example": false
              },
              "excludeFromMarketing": {
                "type": "boolean",
                "example": false
              },
              "address": {
                "type": "object",
                "properties": {
                  "formatted": {
                    "type": "string",
                    "description": "The full, formatted address string.",
                    "example": "Postbus 123456 1111AB Amsterdam"
                  },
                  "street": {
                    "type": "string",
                    "description": "The street name.",
                    "example": "Postbus 123456"
                  },
                  "houseNumber": {
                    "type": "integer",
                    "description": "The house number.",
                    "example": 12
                  },
                  "houseNumberAddition": {
                    "type": "string",
                    "description": "The house number addition (e.g., 'A', '1').",
                    "nullable": true,
                    "example": null
                  },
                  "houseLetter": {
                    "type": "string",
                    "description": "The house letter (e.g., 'A', 'B').",
                    "nullable": true,
                    "example": null
                  },
                  "postalCode": {
                    "type": "string",
                    "description": "The postal code.",
                    "example": "1111AB"
                  },
                  "city": {
                    "type": "string",
                    "description": "The city name.",
                    "example": "Amsterdam"
                  },
                  "province": {
                    "type": "string",
                    "description": "The province name.",
                    "example": "Noord-Holland"
                  },
                  "municipality": {
                    "type": "string",
                    "description": "The municipality name.",
                    "example": "Amsterdam"
                  },
                  "country": {
                    "type": "string",
                    "description": "The country code (e.g., NLD).",
                    "example": "NLD"
                  },
                  "coordinates": {
                    "type": "object",
                    "properties": {
                      "latitude": {
                        "type": "number",
                        "format": "float",
                        "description": "The latitude coordinate.",
                        "example": 123.456
                      },
                      "longitude": {
                        "type": "number",
                        "format": "float",
                        "description": "The longitude coordinate.",
                        "example": 456.123
                      }
                    }
                  },
                  "countrySpecific": {
                    "type": "object",
                    "properties": {
                      "identifiers": {
                        "type": "object",
                        "properties": {
                          "bag": {
                            "type": "object",
                            "properties": {
                              "system": {
                                "type": "string",
                                "description": "The system from which the identifier originates (e.g., BAG).",
                                "example": "BAG"
                              },
                              "value": {
                                "type": "object",
                                "properties": {
                                  "addressableObjectID": {
                                    "type": "integer",
                                    "format": "int64",
                                    "description": "The addressable object ID.",
                                    "example": 123
                                  },
                                  "numberIndicationID": {
                                    "type": "integer",
                                    "format": "int64",
                                    "description": "The number indication ID.",
                                    "example": 456
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  "registrationDate": {
                    "type": "string",
                    "format": "date",
                    "description": "The date the address was registered.",
                    "example": "1979-01-01"
                  },
                  "visibilityStatus": {
                    "type": "string",
                    "description": "The visibility status of the address.",
                    "enum": [
                      "visible",
                      "protected"
                    ],
                    "example": "visible"
                  }
                }
              },
              "correspondenceAddress": {
                "type": "object",
                "properties": {
                  "formatted": {
                    "type": "string",
                    "description": "The full, formatted address string.",
                    "example": "Postbus 123456 1111AB Amsterdam"
                  },
                  "street": {
                    "type": "string",
                    "description": "The street name.",
                    "example": "Postbus 123456"
                  },
                  "houseNumber": {
                    "type": "integer",
                    "description": "The house number.",
                    "example": 12
                  },
                  "houseNumberAddition": {
                    "type": "string",
                    "description": "The house number addition (e.g., 'A', '1').",
                    "nullable": true,
                    "example": null
                  },
                  "houseLetter": {
                    "type": "string",
                    "description": "The house letter (e.g., 'A', 'B').",
                    "nullable": true,
                    "example": null
                  },
                  "postalCode": {
                    "type": "string",
                    "description": "The postal code.",
                    "example": "1111AB"
                  },
                  "city": {
                    "type": "string",
                    "description": "The city name.",
                    "example": "Amsterdam"
                  },
                  "province": {
                    "type": "string",
                    "description": "The province name.",
                    "example": "Noord-Holland"
                  },
                  "municipality": {
                    "type": "string",
                    "description": "The municipality name.",
                    "example": "Amsterdam"
                  },
                  "country": {
                    "type": "string",
                    "description": "The country code (e.g., NLD).",
                    "example": "NLD"
                  },
                  "coordinates": {
                    "type": "object",
                    "properties": {
                      "latitude": {
                        "type": "number",
                        "format": "float",
                        "description": "The latitude coordinate.",
                        "example": 123.456
                      },
                      "longitude": {
                        "type": "number",
                        "format": "float",
                        "description": "The longitude coordinate.",
                        "example": 456.123
                      }
                    }
                  },
                  "countrySpecific": {
                    "type": "object",
                    "properties": {
                      "identifiers": {
                        "type": "object",
                        "properties": {
                          "bag": {
                            "type": "object",
                            "properties": {
                              "system": {
                                "type": "string",
                                "description": "The system from which the identifier originates (e.g., BAG).",
                                "example": "BAG"
                              },
                              "value": {
                                "type": "object",
                                "properties": {
                                  "addressableObjectID": {
                                    "type": "integer",
                                    "format": "int64",
                                    "description": "The addressable object ID.",
                                    "example": 123
                                  },
                                  "numberIndicationID": {
                                    "type": "integer",
                                    "format": "int64",
                                    "description": "The number indication ID.",
                                    "example": 456
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  "registrationDate": {
                    "type": "string",
                    "format": "date",
                    "description": "The date the address was registered.",
                    "example": "1979-01-01"
                  },
                  "visibilityStatus": {
                    "type": "string",
                    "description": "The visibility status of the address.",
                    "enum": [
                      "visible",
                      "protected"
                    ],
                    "example": "visible"
                  }
                }
              },
              "phoneNumbers": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "source": {
                      "type": "string"
                    },
                    "number": {
                      "type": "string"
                    }
                  }
                }
              },
              "websites": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "source": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string"
                    }
                  }
                }
              },
              "emails": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "source": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "activities": {
            "type": "object",
            "properties": {
              "sbi": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "isMain": {
                      "type": "boolean",
                      "description": "Indicates if this is the main source.",
                      "example": false
                    },
                    "source": {
                      "type": "string",
                      "description": "The data sources.",
                      "example": "tradeRegister"
                    },
                    "system": {
                      "type": "string",
                      "description": "The system from which the data originates.",
                      "example": "SBI"
                    },
                    "code": {
                      "type": "string",
                      "description": "The unique code for the classification.",
                      "example": "1071"
                    },
                    "description": {
                      "type": "string",
                      "example": "Manufacture of bread and fresh pastry"
                    }
                  }
                }
              }
            }
          },
          "extensions": {
            "type": "object",
            "properties": {
              "transfers": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "identifiers": {
                      "type": "object",
                      "properties": {
                        "fromTradeRegister": {
                          "type": "object",
                          "properties": {
                            "system": {
                              "type": "string",
                              "description": "The source system of the identifier.",
                              "example": "tradeRegister"
                            },
                            "value": {
                              "type": "string",
                              "example": "12345678"
                            }
                          }
                        },
                        "toTradeRegister": {
                          "type": "object",
                          "properties": {
                            "system": {
                              "type": "string",
                              "description": "The source system of the identifier.",
                              "example": "tradeRegister"
                            },
                            "value": {
                              "type": "string",
                              "example": "12345679"
                            }
                          }
                        }
                      }
                    },
                    "date": {
                      "type": "string",
                      "format": "date",
                      "example": "1979-01-01"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "Resource": {
        "type": "object",
        "required": [
          "type",
          "id"
        ],
        "properties": {
          "type": {
            "type": "string"
          },
          "id": {
            "type": "string"
          }
        }
      },
      "RelationshipToOne": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "oneOf": [
              {
                "$ref": "#/components/schemas/Resource"
              }
            ],
            "nullable": true
          }
        },
        "minProperties": 1
      },
      "ErrorResource": {
        "type": "object",
        "required": [
          "errors"
        ],
        "properties": {
          "errors": {
            "title": "An array of Error objects",
            "type": "array",
            "minItems": 1,
            "items": {
              "type": "object",
              "required": [
                "status",
                "code",
                "title",
                "detail"
              ],
              "properties": {
                "status": {
                  "description": "the HTTP status code applicable to this problem",
                  "type": "string",
                  "minLength": 3,
                  "maxLength": 3
                },
                "code": {
                  "description": "an application-specific error code. It can be the same as 'status'",
                  "type": "string"
                },
                "title": {
                  "description": "a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization",
                  "type": "string"
                },
                "detail": {
                  "description": "a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized",
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "Response": {
        "type": "object",
        "required": [
          "data"
        ],
        "properties": {
          "data": {
            "$ref": "#/components/schemas/Resource"
          }
        },
        "additionalProperties": false
      }
    },
    "parameters": {
      "acceptLanguage": {
        "name": "Accept-Language",
        "in": "header",
        "description": "determines the language of descriptions in the response. If you do not specify the language, the en description will be returned.\n",
        "required": false,
        "schema": {
          "type": "string",
          "example": "nl",
          "enum": [
            "nl",
            "en"
          ]
        }
      },
      "include": {
        "name": "include",
        "in": "query",
        "description": "A comma-separated list of relationship paths to be included as a compound document. This allows you to request that related resources be returned with the primary data in the `included` array.\n",
        "required": false,
        "allowEmptyValue": true,
        "style": "form",
        "explode": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "organizations"
          ]
        }
      },
      "branchIdParam": {
        "name": "branch_id",
        "in": "path",
        "description": "Specifies branch id\n",
        "required": true,
        "schema": {
          "type": "string"
        }
      }
    },
    "headers": {
      "X-Correlation-Id": {
        "description": "Unique request identifier",
        "schema": {
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "examples": {
      "BadRequestExample": {
        "value": {
          "errors": [
            {
              "status": "400",
              "code": "bad-request",
              "title": "Bad Request",
              "detail": "The request payload contains an invalid or missing field."
            }
          ]
        }
      },
      "NotFoundExample": {
        "value": {
          "errors": [
            {
              "status": "404",
              "code": "not-found",
              "title": "Resource Not Found",
              "detail": "The requested resource does not exist."
            }
          ]
        }
      },
      "InternalServerErrorExample": {
        "value": {
          "errors": [
            {
              "status": "500",
              "code": "internal-server-error",
              "title": "Internal Server Error",
              "detail": "An unexpected server error occurred."
            }
          ]
        }
      }
    },
    "responses": {
      "400": {
        "description": "Bad Request",
        "content": {
          "application/vnd.api+json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResource"
            },
            "examples": {
              "badRequest": {
                "$ref": "#/components/examples/BadRequestExample"
              }
            }
          }
        }
      },
      "404": {
        "description": "Not Found",
        "content": {
          "application/vnd.api+json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResource"
            },
            "examples": {
              "notFound": {
                "$ref": "#/components/examples/NotFoundExample"
              }
            }
          }
        }
      },
      "500": {
        "description": "Internal Server Error",
        "content": {
          "application/vnd.api+json": {
            "schema": {
              "$ref": "#/components/schemas/ErrorResource"
            },
            "examples": {
              "internalServerError": {
                "$ref": "#/components/examples/InternalServerErrorExample"
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "proxy-enabled": false
  }
}
```