# Get universal list of organization workspaces

- Operation ID: `getBusinessProfilesUniversalList`
- HTTP method: `GET`
- Path: `/business-profile-service/business-profiles`
- [Human-readable API reference](https://hub.synerise.com/api-reference/organizations#tag/Organization-workspaces/operation/getBusinessProfilesUniversalList)

## Self-contained OpenAPI method

The fenced document below contains this method's documentation and all of its local references. It is self-contained; no category or master specification fetch is required.

```yaml
openapi: 3.0.0
info:
  title: Synerise Public API
  version: 1.9.1
paths:
  /business-profile-service/business-profiles:
    get:
      tags:
        - Organization workspaces
      summary: Get universal list of organization workspaces
      operationId: getBusinessProfilesUniversalList
      description: |
        Retrieve a universal list of workspaces available to the user.

        ---

        **API consumer:** <a href="/api-reference/authorization?tag=Authorization&amp;operationId=userLogin" target="_blank" rel="noopener">Synerise User</a>
      parameters:
        - name: page
          description: Page to retrieve
          in: query
          required: false
          schema:
            type: integer
            format: int32
            default: 1
        - name: limit
          description: Limit of items per page
          in: query
          required: false
          schema:
            type: integer
            format: int32
            default: 20
        - name: favorite
          in: query
          required: false
          schema:
            type: boolean
        - name: search
          description: String to search for
          in: query
          required: false
          schema:
            type: string
            default: ""
        - name: sortBy
          in: query
          schema:
            type: string
            default: CREATED:ASC
            enum:
              - ID:ASC
              - ID:DESC
              - NAME:ASC
              - NAME:DESC
              - CREATED:ASC
              - CREATED:DESC
              - FAVORITE:ASC
              - FAVORITE:DESC
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: List of workspaces
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                          format: int64
                          description: ID of the workspace
                        guid:
                          type: string
                          format: uuid
                          description: GUID of the workspace
                        organizationId:
                          type: number
                          format: int64
                          description: ID of the organization
                        organizationGuid:
                          type: string
                          format: uuid
                          description: GUID of the organization
                        name:
                          type: string
                          description: Name of the workspace
                        subdomain:
                          type: string
                          description: Subdomain of the workspace
                        logo:
                          type: string
                          description: Logo of the workspace
                        hash:
                          type: string
                          description: Hash ID of the workspace
                        created:
                          type: integer
                          format: int64
                          description: Creation date
                        updated:
                          type: integer
                          format: int64
                          description: Last update time
                        ipRestriction:
                          type: string
                          enum:
                            - OFF
                            - PASSB
                            - FAIL
                            - ENFORCED
                        mfaRestriction:
                          type: string
                          enum:
                            - OFF
                            - PASS
                            - FAIL
                            - ENFORCED
                        tags:
                          type: array
                          items:
                            type: string
                        favorite:
                          type: boolean
                  meta:
                    type: object
                    description: Pagination data
                    properties:
                      count:
                        type: integer
                        format: int32
                        description: Total number of items
                      limit:
                        type: integer
                        format: int32
                        description: Number of items per page
                      links:
                        type: array
                        description: Links to other pages
                        items:
                          type: object
                          properties:
                            rel:
                              type: string
                              description: Type of page relation
                              enum:
                                - first
                                - next
                                - prev
                            url:
                              type: string
                              description: URL of the page
      x-snr-doc-urls:
        - /api-reference/organizations#tag/Organization-workspaces/operation/getBusinessProfilesUniversalList
      x-codeSamples:
        - lang: cURL
          label: cURL
          source: |-
            curl --request GET \
              --url 'https://api.synerise.com/business-profile-service/business-profiles?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&favorite=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE'
        - lang: Python
          label: Python
          source: |-
            import http.client

            conn = http.client.HTTPSConnection("api.synerise.com")

            conn.request("GET", "/business-profile-service/business-profiles?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&favorite=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE")

            res = conn.getresponse()
            data = res.read()

            print(data.decode("utf-8"))
        - lang: JavaScript
          label: JavaScript
          source: |-
            const data = null;

            const xhr = new XMLHttpRequest();
            xhr.withCredentials = true;

            xhr.addEventListener("readystatechange", function () {
              if (this.readyState === this.DONE) {
                console.log(this.responseText);
              }
            });

            xhr.open("GET", "https://api.synerise.com/business-profile-service/business-profiles?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&favorite=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE");

            xhr.send(data);
        - lang: Node.js
          label: Node.js
          source: |-
            const http = require("https");

            const options = {
              "method": "GET",
              "hostname": "api.synerise.com",
              "port": null,
              "path": "/business-profile-service/business-profiles?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&favorite=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE",
              "headers": {}
            };

            const req = http.request(options, function (res) {
              const chunks = [];

              res.on("data", function (chunk) {
                chunks.push(chunk);
              });

              res.on("end", function () {
                const body = Buffer.concat(chunks);
                console.log(body.toString());
              });
            });

            req.end();
        - lang: PHP
          label: PHP
          source: |-
            <?php

            $request = new HttpRequest();
            $request->setUrl('https://api.synerise.com/business-profile-service/business-profiles');
            $request->setMethod(HTTP_METH_GET);

            $request->setQueryData([
              'page' => 'SOME_INTEGER_VALUE',
              'limit' => 'SOME_INTEGER_VALUE',
              'favorite' => 'SOME_BOOLEAN_VALUE',
              'search' => 'SOME_STRING_VALUE',
              'sortBy' => 'SOME_STRING_VALUE'
            ]);

            try {
              $response = $request->send();

              echo $response->getBody();
            } catch (HttpException $ex) {
              echo $ex;
            }
        - lang: Java
          label: Java
          source: |-
            HttpResponse<String> response = Unirest.get("https://api.synerise.com/business-profile-service/business-profiles?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&favorite=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE")
              .asString();
servers:
  - description: Microsoft Azure EU
    url: https://api.synerise.com
  - description: Microsoft Azure USA
    url: https://api.azu.synerise.com
  - description: Google Cloud Platform
    url: https://api.geb.synerise.com
tags:
  - name: Organization workspaces
```
