> ## Documentation Index > Fetch the complete documentation index at: https://devs.surferseo.com/llms.txt > Use this file to discover all available pages before exploring further. # List workspaces > > **Deprecated.** Use [GET /api/v2/workspaces](/api/v2/workspaces/list-workspaces) instead. List all active workspaces in the organization associated with the API key. ## OpenAPI ````yaml /api/openapi-v1.json get /api/v1/workspaces openapi: 3.0.0 info: description: > Welcome to the official Surfer API documentation! The API is only available to active users with the **API add-on** or users on an **Enterprise plan**. Need access? Reach out to us: - support@surferseo.com for API add-on - sales@surferseo.com for Enterprise plan details # Authentication We use API keys to authenticate requests. Most requests require authentication, unless stated otherwise. All requests must be made over HTTPS. If you are eligible, email us at support@surferseo.com and we’ll set you up with the API key. Having API access doesn't automatically grant you access to all tools. If your plan doesn’t include Audit or SERP Analyzer, you won’t be able to use their API endpoints. # Testing and sandbox At the moment, we don’t have a sandbox environment for testing. Any API queries you run will count toward your account limits. # Webhooks We use webhooks to notify you of certain events such as AI article status or Content Score changes. **Setup process:** - Set up on your end an HTTPS address which will listen for requests and respond with a `2xx` status. - Reach out to Surfer's support team via email or live chat and share the URL you prepared. - Our support team will set everything up and share a verification key for authentication on your end. Our server will issue a POST request with `Verification-Key` header and a JSON body. Details about individual events are available in the associated endpoint documentation. # Errors We use standard HTTP response codes to indicate request status: - `2xx`: Success - `4xx`: Client-side issue (e.g., missing parameters) - `5xx`: Server-side issue If a request fails due to invalid parameters, you’ll get a 422 response with an error object following the [JSON:API spec](https://jsonapi.org/format/#error-objects), which includes: - `title`: a short, human-readable summary of the problem, - `detail`: a human-readable explanation specific to the problem, - `source`: an object containing references to the source of the error: - `pointer`: a pointer to the associated entity in the request (e.g. `"/keywords[0]"`). title: Surfer API version: v1.0 x-logo: altText: Surfer API Documentation href: / url: >- data:image/svg+xml,%3Csvg width='498' height='91' viewBox='0 0 498 91' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M68.9831 0.971985C80.4969 0.971985 89.8306 10.3057 89.8306 21.8194L89.8306 27.3153L80.5085 30.1808V21.7851C80.49 15.4356 75.337 10.294 68.9831 10.294H20.8475C14.4822 10.294 9.32209 15.4541 9.32209 21.8194V44.0486C9.32209 47.9107 9.32209 49.8417 8.26073 51.2783C7.19938 52.7149 5.3536 53.2822 1.66204 54.417L1.62175e-05 54.9278L5.15498e-05 21.8194C5.15498e-05 10.3057 9.33378 0.971985 20.8475 0.971985H68.9831Z' fill='%23FF5B49'/%3E%3Cpath d='M88.1685 37.5614L89.8306 37.0505L89.8306 70.1245C89.8306 81.6383 80.4968 90.972 68.9831 90.972H20.8475C9.33373 90.972 0 81.6383 0 70.1245L5.82831e-06 64.6631L9.32209 61.7976V70.1585C9.34039 76.5082 14.4935 81.65 20.8475 81.65H68.9831C75.3484 81.65 80.5085 76.4898 80.5085 70.1245V47.9298C80.5085 44.0677 80.5085 42.1367 81.5699 40.7001C82.6312 39.2635 84.477 38.6962 88.1685 37.5614Z' fill='%23FF5B49'/%3E%3Cpath d='M25.1189 60.0995V42.6931C25.1189 38.1058 26.0766 37.1483 30.6638 37.1483H32.3793C36.967 37.1483 37.9242 38.1056 37.9242 42.6931V60.0995C37.9242 64.6871 36.967 65.6444 32.3793 65.6444H30.6638C26.0766 65.6444 25.1189 64.6868 25.1189 60.0995Z' fill='%23FF5B49'/%3E%3Cpath d='M57.4504 26.3099C52.8632 26.3099 51.9055 27.2675 51.9055 31.8548V60.0994C51.9055 64.6868 52.8632 65.6442 57.4504 65.6442H59.1659C63.7536 65.6442 64.7108 64.687 64.7108 60.0994V31.8548C64.7108 27.2672 63.7536 26.3099 59.1659 26.3099H57.4504Z' fill='%23FF5B49'/%3E%3Cpath d='M153.196 24.2798C155.307 25.8338 156.501 28.0141 156.779 30.8205H171.218C171.148 26.576 170.012 22.8418 167.808 19.6179C165.605 16.3939 162.52 13.8773 158.554 12.0682C154.611 10.2591 149.995 9.35452 144.707 9.35452C139.512 9.35452 134.873 10.2591 130.791 12.0682C126.709 13.8773 123.496 16.3939 121.154 19.6179C118.834 22.8418 117.686 26.6108 117.709 30.9249C117.686 36.1899 119.414 40.3764 122.893 43.4844C126.372 46.5924 131.115 48.877 137.123 50.3382L144.881 52.2865C147.479 52.9128 149.671 53.6086 151.456 54.374C153.266 55.1394 154.634 56.0672 155.562 57.1573C156.513 58.2474 156.988 59.5926 156.988 61.193C156.988 62.9094 156.466 64.4286 155.423 65.7506C154.379 67.0727 152.906 68.1048 151.004 68.847C149.125 69.5892 146.91 69.9603 144.359 69.9603C141.761 69.9603 139.43 69.566 137.366 68.7774C135.325 67.9657 133.69 66.7712 132.461 65.194C131.255 63.5936 130.57 61.5989 130.408 59.2099H115.831C115.947 64.3358 117.187 68.6383 119.553 72.1174C121.942 75.5733 125.259 78.1826 129.503 79.9453C133.771 81.7081 138.781 82.5894 144.533 82.5894C150.332 82.5894 155.283 81.7197 159.389 79.9801C163.517 78.2174 166.672 75.7472 168.852 72.5697C171.055 69.3689 172.169 65.5883 172.192 61.2278C172.169 58.259 171.624 55.6265 170.557 53.3303C169.513 51.0341 168.04 49.0394 166.138 47.3462C164.236 45.6531 161.987 44.2266 159.389 43.0669C156.791 41.9072 153.938 40.9795 150.83 40.2837L144.429 38.7529C142.875 38.405 141.413 37.9875 140.045 37.5004C138.677 36.9901 137.471 36.3987 136.427 35.7261C135.383 35.0302 134.56 34.2069 133.957 33.2559C133.377 32.3049 133.11 31.1916 133.156 29.916C133.156 28.3852 133.597 27.0167 134.479 25.8106C135.383 24.6046 136.682 23.6652 138.375 22.9926C140.068 22.2968 142.144 21.9488 144.603 21.9488C148.221 21.9488 151.085 22.7258 153.196 24.2798Z' fill='black'/%3E%3Cpath d='M242.548 10.3287H227.483V55.3134C227.483 58.027 226.88 60.4392 225.674 62.5499C224.491 64.6605 222.81 66.3189 220.63 67.525C218.473 68.7311 215.933 69.3341 213.01 69.3341C210.111 69.3341 207.571 68.7311 205.391 67.525C203.211 66.3189 201.518 64.6605 200.312 62.5499C199.129 60.4392 198.537 58.027 198.537 55.3134V10.3287H183.473V56.6006C183.473 61.7961 184.702 66.3421 187.161 70.2387C189.619 74.1352 193.064 77.1737 197.494 79.3539C201.924 81.5109 207.096 82.5894 213.01 82.5894C218.902 82.5894 224.062 81.5109 228.492 79.3539C232.922 77.1737 236.367 74.1352 238.825 70.2387C241.307 66.3421 242.548 61.7961 242.548 56.6006V10.3287Z' fill='black'/%3E%3Cpath fill-rule='evenodd' clip-rule='evenodd' d='M256.09 81.5805V10.3287H284.201C289.582 10.3287 294.175 11.2912 297.978 13.2163C301.805 15.1182 304.716 17.8203 306.711 21.3226C308.729 24.8017 309.738 28.8954 309.738 33.6038C309.738 38.3354 308.717 42.4059 306.676 45.8154C304.635 49.2017 301.678 51.7995 297.805 53.6086C297.592 53.7084 297.377 53.8054 297.16 53.8997L312.278 81.5805H295.647L282.151 56.3223H271.155V81.5805H256.09ZM281.383 44.215H271.155V22.6447H281.314C284.213 22.6447 286.613 23.0738 288.515 23.9319C290.44 24.7669 291.867 25.9962 292.795 27.6198C293.746 29.2433 294.221 31.238 294.221 33.6038C294.221 35.9464 293.746 37.9063 292.795 39.4835C291.867 41.0607 290.452 42.2436 288.55 43.0322C286.648 43.8207 284.259 44.215 281.383 44.215Z' fill='black'/%3E%3Cpath d='M321.532 10.3287V81.5805H336.596V52.1474H365.577V39.727H336.596V22.749H368.708V10.3287H321.532Z' fill='black'/%3E%3Cpath d='M379.989 81.5805V10.3287H428.001V22.749H395.054V39.727H425.531V52.1474H395.054V69.1601H428.14V81.5805H379.989Z' fill='black'/%3E%3Cpath fill-rule='evenodd' clip-rule='evenodd' d='M441.126 10.3287V81.5805H456.19V56.3223H467.187L480.683 81.5805H497.313L482.196 53.8997C482.413 53.8054 482.628 53.7084 482.84 53.6086C486.714 51.7995 489.671 49.2017 491.712 45.8154C493.753 42.4059 494.773 38.3354 494.773 33.6038C494.773 28.8954 493.764 24.8017 491.747 21.3226C489.752 17.8203 486.841 15.1182 483.014 13.2163C479.21 11.2912 474.618 10.3287 469.237 10.3287H441.126ZM456.19 44.215H466.419C469.295 44.215 471.684 43.8207 473.586 43.0322C475.488 42.2436 476.902 41.0607 477.83 39.4835C478.781 37.9063 479.257 35.9464 479.257 33.6038C479.257 31.238 478.781 29.2433 477.83 27.6198C476.902 25.9962 475.476 24.7669 473.551 23.9319C471.649 23.0738 469.248 22.6447 466.349 22.6447H456.19V44.215Z' fill='black'/%3E%3C/svg%3E servers: - url: https://app.surferseo.com variables: {} security: [] tags: - description: > Endpoints for interacting with Content Editor queries, which are the underlying data source for Surfer Guidelines. name: Content Editors x-displayName: Content Editors - description: | Endpoints for interacting with Audit queries. name: Audit x-displayName: Audit - description: | Endpoints for interacting with SERP Analyzer queries. name: SERP Analyzer x-displayName: SERP Analyzer - description: | Endpoints for interacting with other resources. name: Other x-displayName: Other paths: /api/v1/workspaces: get: tags: - Other summary: List workspaces description: > > **Deprecated.** Use [GET /api/v2/workspaces](/api/v2/workspaces/list-workspaces) instead. List all active workspaces in the organization associated with the API key. operationId: KSeoWeb.Api.V1.Workspaces.Controller.index parameters: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkspacesResponse' description: OK callbacks: {} deprecated: true security: - API Key: [] components: schemas: WorkspacesResponse: properties: data: description: List of workspaces items: $ref: '#/components/schemas/Workspace' type: array required: - data title: WorkspacesResponse type: object Workspace: properties: id: description: Workspace ID type: integer name: description: Workspace name type: string required: - id - name title: Workspace type: object securitySchemes: API Key: in: header name: API-KEY type: apiKey ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.