Source Wiki
    Source Wiki
    • List of Categories
      GET
    • List of Source Items (Documents)
      GET
    • Show Source Item (Document)
      GET

      List of Source Items (Documents)

      Developing
      GET
      /api/{organization}/source-items
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location -g --request GET '/api/y91o1vbv1NJlkkvTnkuSVKPCuaAb0dA0/source-items?filters[term]=&filters[flatten]=&filters[project_id]&page=1&per_page=10&order_by=title&order_type=asc&includes[]=currentDocument&includes[]=author&includes[]=project'
      Response Response Example
      {
    "data": [
        {
            "source_item_id": 0,
            "project_id": 0,
            "parent_id": null,
            "title": "string",
            "description": null,
            "type": "string",
            "shared": true,
            "status": "string",
            "sort": 0,
            "subitems_count": null,
            "created_at": "string",
            "updated_at": "string",
            "created_by": 0,
            "updated_by": 0,
            "is_policy": 0,
            "autosave": true,
            "data": {
                "color": "string"
            },
            "favorite": 0,
            "views": 0,
            "subitems": [
                {
                    "source_item_id": 0,
                    "project_id": 0,
                    "parent_id": 0,
                    "title": "string",
                    "description": null,
                    "type": "string",
                    "shared": true,
                    "status": "string",
                    "sort": 0,
                    "subitems_count": null,
                    "created_at": "string",
                    "updated_at": "string",
                    "created_by": 0,
                    "updated_by": 0,
                    "is_policy": 0,
                    "autosave": true,
                    "data": {
                        "color": "string"
                    },
                    "favorite": 0,
                    "views": 0,
                    "subitems": [
                        {
                            "source_item_id": 0,
                            "project_id": 0,
                            "parent_id": 0,
                            "title": "string",
                            "description": null,
                            "type": "string",
                            "shared": true,
                            "status": "string",
                            "sort": 0,
                            "subitems_count": null,
                            "created_at": "string",
                            "updated_at": "string",
                            "created_by": 0,
                            "updated_by": 0,
                            "is_policy": 0,
                            "autosave": true,
                            "data": null,
                            "favorite": 0,
                            "views": 0,
                            "subitems": [
                                "string"
                            ],
                            "loading": true,
                            "author": {
                                "id": 0,
                                "goteam_id": 0,
                                "user_id": 0,
                                "name": "string",
                                "fname": "string",
                                "mname": null,
                                "lname": "string",
                                "first_name": "string",
                                "last_name": "string",
                                "initials": "string",
                                "email": "string",
                                "avatar": null,
                                "status": "string",
                                "source": "string",
                                "superadmin": true,
                                "org_admin": true,
                                "role": "string",
                                "mfa": 0,
                                "created_at": "string",
                                "goteam_internal": true,
                                "two_factor_confirmed_at": null,
                                "goteam_position": null
                            },
                            "document": {
                                "document_id": 0,
                                "source_item_id": 0,
                                "title": "string",
                                "contents": "string",
                                "status": "string",
                                "is_current": true,
                                "expanded": true,
                                "version": 0,
                                "published_at": "string",
                                "updated_at": "string",
                                "snippet": "string",
                                "title_match_count": 0,
                                "content_match_count": 0,
                                "plain_text_content": "string"
                            },
                            "first_document": null,
                            "latest_draft": null,
                            "shareable": null,
                            "total_acknowledgements": null,
                            "total_acknowledged": null,
                            "acknowledgement_rate": 0,
                            "general_access": "string",
                            "can_edit": true,
                            "can_publish": true,
                            "can_delete": true,
                            "url": "string",
                            "public_url": "string"
                        }
                    ],
                    "loading": true,
                    "author": {
                        "id": 0,
                        "goteam_id": 0,
                        "user_id": 0,
                        "name": "string",
                        "fname": "string",
                        "mname": "string",
                        "lname": "string",
                        "first_name": "string",
                        "last_name": "string",
                        "initials": "string",
                        "email": "string",
                        "avatar": "string",
                        "status": "string",
                        "source": "string",
                        "superadmin": true,
                        "org_admin": true,
                        "role": "string",
                        "mfa": 0,
                        "created_at": "string",
                        "goteam_internal": true,
                        "two_factor_confirmed_at": null,
                        "goteam_position": null
                    },
                    "document": {
                        "document_id": 0,
                        "source_item_id": 0,
                        "title": "string",
                        "contents": "string",
                        "status": "string",
                        "is_current": true,
                        "expanded": true,
                        "version": 0,
                        "published_at": "string",
                        "updated_at": "string",
                        "snippet": "string",
                        "title_match_count": 0,
                        "content_match_count": 0,
                        "plain_text_content": "string"
                    },
                    "first_document": null,
                    "latest_draft": null,
                    "shareable": null,
                    "total_acknowledgements": null,
                    "total_acknowledged": null,
                    "acknowledgement_rate": 0,
                    "general_access": "string",
                    "can_edit": true,
                    "can_publish": true,
                    "can_delete": true,
                    "url": "string",
                    "public_url": "string"
                }
            ],
            "loading": true,
            "author": {
                "id": 0,
                "goteam_id": 0,
                "user_id": 0,
                "name": "string",
                "fname": "string",
                "mname": "string",
                "lname": "string",
                "first_name": "string",
                "last_name": "string",
                "initials": "string",
                "email": "string",
                "avatar": "string",
                "status": "string",
                "source": "string",
                "superadmin": true,
                "org_admin": true,
                "role": "string",
                "mfa": 0,
                "created_at": "string",
                "goteam_internal": true,
                "two_factor_confirmed_at": "string",
                "goteam_position": null
            },
            "document": {
                "document_id": 0,
                "source_item_id": 0,
                "title": "string",
                "contents": "string",
                "status": "string",
                "is_current": true,
                "expanded": true,
                "version": 0,
                "published_at": "string",
                "updated_at": "string",
                "snippet": "string",
                "title_match_count": 0,
                "content_match_count": 0,
                "plain_text_content": "string"
            },
            "first_document": null,
            "latest_draft": null,
            "shareable": null,
            "project": {
                "project_id": 0,
                "name": "string",
                "description": "string",
                "image_url": "string",
                "image_path": "string",
                "avatar_url": "string",
                "color_hex": "string",
                "general_access": "string",
                "sort": 0,
                "created_by": 0,
                "updated_by": 0,
                "created_at": "string",
                "updated_at": "string",
                "archived_at": null,
                "folder_count": 0,
                "subitems_count": 0,
                "documents_count": 0,
                "organization": {
                    "id": 0,
                    "org_id": 0,
                    "gta_id": 0,
                    "source": "string",
                    "name": "string",
                    "identifier": "string",
                    "email": "string",
                    "status": "string",
                    "brand_url": "string",
                    "last_login_at": null,
                    "date_registered": null,
                    "max_users": null,
                    "enable_ai": true,
                    "created_at": "string",
                    "updated_at": "string",
                    "archived_at": null,
                    "project_count": 0,
                    "user_count": 0,
                    "is_goteam_org": true
                },
                "url": "string",
                "can_edit": true
            },
            "total_acknowledgements": null,
            "total_acknowledged": null,
            "acknowledgement_rate": 0,
            "general_access": "string",
            "can_edit": true,
            "can_publish": true,
            "can_delete": true,
            "url": "string",
            "public_url": "string"
        }
    ],
    "links": {
        "first": "string",
        "last": "string",
        "prev": null,
        "next": "string"
    },
    "meta": {
        "current_page": 0,
        "from": 0,
        "last_page": 0,
        "links": [
            {
                "url": "string",
                "label": "string",
                "active": true
            }
        ],
        "path": "string",
        "per_page": 0,
        "to": 0,
        "total": 0
    }
}

      Request

      Authorization
      Provide your bearer token in the
      Authorization
      header when making requests to protected resources.
      Example:
      Authorization: Bearer ********************
      Path Params
      organization
      string 
      required
      The organization identifier from Source Wiki
      Example:
      y91o1vbv1NJlkkvTnkuSVKPCuaAb0dA0
      Query Params
      filters[term]
      string 
      optional
      A keyword or phrase used to filter results by matching relevant fields, such as titles.
      filters[flatten]
      integer 
      optional
      Determines the structure of the results. Use 1 to return a flat list (no tree view), or 0 to preserve the hierarchical (tree) structure. Defaults to 0.
      filters[project_id]
      integer 
      optional
      Filters the results to include only items associated with the specified project ID.
      page
      integer 
      optional
      The page number of the paginated results to retrieve. Used in combination with 'per_page' to navigate through result sets.
      Example:
      1
      per_page
      integer 
      optional
      The number of results to return per page. Used for pagination in conjunction with the page parameter.
      Example:
      10
      order_by
      string 
      optional
      The name of the column by which to sort the results. Must correspond to a valid sortable field.
      Example:
      title
      order_type
      string 
      optional
      The sort direction for the results. Accepts 'asc' for ascending order or 'desc' for descending order.
      Example:
      asc
      includes[]
      array[string]
      optional
      A list of related resources to include in the response. This allows for eager loading of relationships to reduce the number of queries.
      Example:
      ["currentDocument","author","project"]

      Responses

      🟢200OK
      application/json
      Body
      data
      array [object {36}] 
      required
      source_item_id
      integer 
      required
      project_id
      integer 
      required
      parent_id
      null 
      required
      title
      string 
      required
      description
      null 
      required
      type
      string 
      required
      shared
      boolean 
      required
      status
      string 
      required
      sort
      integer 
      required
      subitems_count
      null 
      required
      created_at
      string 
      required
      updated_at
      string 
      required
      created_by
      integer 
      required
      updated_by
      integer 
      required
      is_policy
      integer 
      required
      autosave
      boolean 
      required
      data
      object 
      required
      favorite
      integer 
      required
      views
      integer 
      required
      subitems
      array [object {35}] 
      required
      loading
      boolean 
      required
      author
      object 
      required
      document
      object  | null 
      required
      first_document
      null 
      required
      latest_draft
      null 
      required
      shareable
      null 
      required
      project
      object 
      required
      total_acknowledgements
      null 
      required
      total_acknowledged
      null 
      required
      acknowledgement_rate
      integer 
      required
      general_access
      string 
      required
      can_edit
      boolean 
      required
      can_publish
      boolean 
      required
      can_delete
      boolean 
      required
      url
      string 
      required
      public_url
      string 
      required
      links
      object 
      required
      first
      string 
      required
      last
      string 
      required
      prev
      null 
      required
      next
      string 
      required
      meta
      object 
      required
      current_page
      integer 
      required
      from
      integer 
      required
      last_page
      integer 
      required
      links
      array [object {3}] 
      required
      path
      string 
      required
      per_page
      integer 
      required
      to
      integer 
      required
      total
      integer 
      required
      Modified at 2025-05-07 03:48:42
      Previous
      List of Categories
      Next
      Show Source Item (Document)
      Built with