Skip to content

Add documentation for circle endpoints #930

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions content/en/entities/circle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Circle
description: Represents a collection of some users that follow the authenticated user.
menu:
docs:
parent: entities
---

## Example

```javascript
{
"id": "12249",
"title": "Friends"
}
```

## Required attributes

### `id` {#id}

**Description:** The internal database ID of the circle.\
**Type:** String \(cast from an integer, but not guaranteed to be a number\)\

### `title` {#title}

**Description:** The user-defined title of the circle.\
**Type:** String\
**Version history:**\
2.1.0 - added

## See also

{{< page-ref page="methods/circles.md" >}}
Loading